Перейти к основному содержимому
Версия: v2

Update

Объект какого-либо события (обновления), которое относится к боту. Содержит идентификатор и одно из заполненных полей в зависимости от типа события.

updateIdinteger<int64>

Идентификатор обновления, монотонно возрастает. Более поздние обновления имеют бОльший идентификатор

message object

Объект обновления - сообщение

workspaceIdstringrequired

Id рабочего пространства, в котором было отправлено сообщение

Example: AIQffAsGi8
chatIdstringrequired

Id чата, в который отправлено сообщение

Example: w:AIQffAsGi8
messageIdstringrequired

Id сообщения

Example: gIQffAsGi8
messageTypeMessageType (string)required

Тип сообщения - от пользователя либо системное

Possible values: [USER, SYSTEM]

Example: USER
inReplyToMessageIdstring

Id сообщения, на которое было отвечено этим сообщением

Example: gIQffAsGi8
membershipIdstringrequired

Id автора сообщения

Example: gIQffAsGi8
createdAtstring<date-time>required

Дата и время создания сообщения

Example: 2023-02-26T18:58:36.154+03:00
updatedAtstring<date-time>required

Дата и время последнего изменения сообщения

Example: 2024-02-26T18:58:36.154+03:00
content objectrequired

Содержимое сообщения. Как минимум одно поле не пустое

textstring

Сообщение в формате Markdown

Example: Привет!
fileIdsstring[]

Массив из Id файлов, которые прикреплены к сообщению

Example: [ADK5NyCqIK, BDK5NyCqIK]
conferenceIdstring

Id конференции

Example: gIQffAsGi8
systemEvent object

Содержимое системного сообщения. Как минимум одно поле не пустое

chatCreated object

Системное сообщение создания чата

creatorMembershipIdstringrequired

Membership Id создателя чата

Example: ADK5NyCqIK
membershipIdsstring[]

Массив из Membership Id участников созданного чата

Example: [ADK5NyCqIK, BDK5NyCqIK]
chatConvertedToPrivate object

Системное сообщение создания чата

initiatorMembershipIdstringrequired

Membership Id инициатора конвертации чата в приватный

Example: ADK5NyCqIK
membersJoined object

Системное сообщение присоединения новых участников к чату

inviterMembershipIdstring

Membership Id участника, который пригласил новых участников

Example: ADK5NyCqIK
membershipIdsstring[]required

Массив из Membership Id приглашенных участников

Example: [ADK5NyCqIK, BDK5NyCqIK]
membersLeft object

Системное сообщение исключения участников из чата

kickerMembershipIdstring

Membership Id участника, который исключил участников

Example: ADK5NyCqIK
membershipIdsstring[]required

Массив из Membership Id исключенных участников

Example: [ADK5NyCqIK, BDK5NyCqIK]
chatRenamed object

Системное сообщение переименования чата

initiatorMembershipIdstringrequired

Membership Id участника, который переименовал чат

Example: ADK5NyCqIK
newNamestringrequired

Новое название чата

Example: Документация
forwardedContent object

Содержимое пересланного сообщения

sourceWorkspaceIdstringrequired

Id рабочего пространства, из которого пересылаются сообщение

Example: AIQffAsGi8
sourceChatIdstringrequired

Id чата, из которого пересылаются сообщение

Example: w:AIQffAsGi8
forwardedMessages object[]required

Массив пересылаемых сообщений. В сообщениях не будет информации о реакциях, обсуждениях, закреплении и о том, является ли сообщение ответом на другое сообщение

  • Array [
  • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
  • userEvent object

    Содержимое персональной нотификации. Как минимум одно поле не пустое

    conferenceMissed object

    Персональная нотификация о пропущенной конференции

    conferenceIdstringrequired

    Идентификатор конференции

    Example: ADK5NyCqIK
    inviterMemberIdstring

    Membership Id инициатора конференции

    Example: ADK5NyCqIK
    conferenceTarget objectrequired

    Данные о конференции. Как минимум одно поле не пустое

    channelCall object

    Конференция в чате

    chatIdstringrequired

    Id чата, в котором инициирована конференция

    Example: w:AIQffAsGi8
    watercooler object

    Персональный звонок

    scopestringrequired

    Тип конференции. PUBLIC - публичный, другие участники могут присоединяться без приглашений, PRIVATE - доступ только по приглашениям

    Possible values: [PRIVATE, PUBLIC]

    Example: PUBLIC
    membershipIdsstring[]required

    Массив из Membership Id участников конференции

    Example: [ADK5NyCqIK, BDK5NyCqIK]
    startedAtstring<date-time>required

    Дата и время старта конференции

    Example: 2023-02-26T18:58:36.154+03:00
    conferenceDeclined object

    Персональная нотификация об отклоненной конференции

    conferenceIdstringrequired

    Идентификатор конференции

    Example: ADK5NyCqIK
    inviterMemberIdstring

    Membership Id инициатора конференции

    Example: ADK5NyCqIK
    conferenceTarget objectrequired

    Данные о конференции. Как минимум одно поле не пустое

    channelCall object

    Конференция в чате

    chatIdstringrequired

    Id чата, в котором инициирована конференция

    Example: w:AIQffAsGi8
    watercooler object

    Персональный звонок

    scopestringrequired

    Тип конференции. PUBLIC - публичный, другие участники могут присоединяться без приглашений, PRIVATE - доступ только по приглашениям

    Possible values: [PRIVATE, PUBLIC]

    Example: PUBLIC
    membershipIdsstring[]required

    Массив из Membership Id участников конференции

    Example: [ADK5NyCqIK, BDK5NyCqIK]
    startedAtstring<date-time>required

    Дата и время старта конференции

    Example: 2023-02-26T18:58:36.154+03:00
    conferenceDirectInvite object

    Персональная нотификация о персональном приглашении на конференцию

    conferenceIdstringrequired

    Идентификатор конференции

    Example: ADK5NyCqIK
    inviterMemberIdstring

    Membership Id инициатора конференции

    Example: ADK5NyCqIK
    conferenceTarget objectrequired

    Данные о конференции. Как минимум одно поле не пустое

    channelCall object

    Конференция в чате

    chatIdstringrequired

    Id чата, в котором инициирована конференция

    Example: w:AIQffAsGi8
    watercooler object

    Персональный звонок

    scopestringrequired

    Тип конференции. PUBLIC - публичный, другие участники могут присоединяться без приглашений, PRIVATE - доступ только по приглашениям

    Possible values: [PRIVATE, PUBLIC]

    Example: PUBLIC
    membershipIdsstring[]required

    Массив из Membership Id участников конференции

    Example: [ADK5NyCqIK, BDK5NyCqIK]
    startedAtstring<date-time>required

    Дата и время старта конференции

    Example: 2023-02-26T18:58:36.154+03:00
    conferenceAnnounce object

    Персональная нотификация о старте доступной конференции

    conferenceIdstringrequired

    Идентификатор конференции

    Example: ADK5NyCqIK
    inviterMemberIdstring

    Membership Id инициатора конференции

    Example: ADK5NyCqIK
    conferenceTarget objectrequired

    Данные о конференции. Как минимум одно поле не пустое

    channelCall object

    Конференция в чате

    chatIdstringrequired

    Id чата, в котором инициирована конференция

    Example: w:AIQffAsGi8
    watercooler object

    Персональный звонок

    scopestringrequired

    Тип конференции. PUBLIC - публичный, другие участники могут присоединяться без приглашений, PRIVATE - доступ только по приглашениям

    Possible values: [PRIVATE, PUBLIC]

    Example: PUBLIC
    membershipIdsstring[]required

    Массив из Membership Id участников конференции

    Example: [ADK5NyCqIK, BDK5NyCqIK]
    startedAtstring<date-time>required

    Дата и время старта конференции

    Example: 2023-02-26T18:58:36.154+03:00
    chatMessageMention object

    Персональная нотификация об упоминании в чате

    chatIdstringrequired

    Id чата, в который было отправлено сообщение

    Example: w:AIQffAsGi8
    chatMessage objectrequired

    Объект сообщения

    0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    reactions object[]

    Массив из реакций к сообщению

  • Array [
  • emojistringrequired

    Emoji в виде :+1:

    Example: :heart:
    countintegerrequired

    Количество реакций

    Example: 5
  • ]
  • threadIdstring

    Id обсуждения под этим сообщением

    Example: t:AIQffAsGi8
    pinnedAtstring<date-time>

    Дата и время закрепления сообщения

    Example: 2024-02-26T18:58:36.154+03:00
    notification object

    Объект обновления - уведомление

    workspaceIdstringrequired

    Id рабочего пространства, к которому относится уведомление

    Example: AIQffAsGi8
    timestampstring<date-time>required

    Время создания уведомления

    Example: 2024-02-26T18:58:36.154+03:00
    memberJoinedEvent object

    Уведомление о присоединении нового участника к рабочему пространству

    memberIdstringrequired

    Membership Id присоединившегося участника

    Example: ADK5NyCqIK
    memberInvitedEvent object

    Уведомление о приглашении нового участника в рабочее пространство

    memberIdstringrequired

    Membership Id приглашенного участника

    Example: ADK5NyCqIK
    memberLeftEvent object

    Уведомление о выходе участника из рабочего пространства

    memberIdstringrequired

    Membership Id участника, покинувшего рабочее пространство

    Example: ADK5NyCqIK
    memberChangedRoleEvent object

    Уведомление об изменении роли участника в рабочем пространстве

    memberIdstringrequired

    Membership Id участника с новой ролью

    Example: ADK5NyCqIK
    newRoleWorkspaceRole (string)required

    Новая роль участника

    Possible values: [MEMBER, ADMIN, OWNER, GUEST, GUEST_CALLER]

    Example: ADMIN
    chatCreatedEvent object

    Уведомление о создании нового чата в рабочем пространстве

    chatIdstringrequired

    Id созданного чата

    Example: w:AIQffAsGi8
    metadata objectrequired

    Содержит специфичную для типа чата информацию. Заполняется одно из полей в зависимости от типа чата

    personal object

    Содержит информацию о персональном чате

    otherMembershipIdstringrequired

    MembershipId собеседника

    Example: aIQffAsGia
    workspace object

    Информация о чате в рабочем пространстве

    namestringrequired

    Название чата

    Example: Новости
    announcebooleanrequired

    Является ли чат анонсным

    Example: true
    chatTypeWorkspaceChatType (string)required

    Тип чата

    Possible values: [PRIVATE, PUBLIC, GENERAL]

    Example: PUBLIC
    autoJoinNewMembersbooleanrequired

    Добавляются ли автоматически новые участники рабочего пространства в чат

    Example: true
    descriptionstring

    Описание чата

    Example: Новости компании
    memberCountintegerrequired

    Число участников

    Example: 5
    thread object

    Информация об обсуждении

    parentChatIdstringrequired

    ChatId родительского чата, где расположено родительское сообщение

    Example: w:aIQffAsGia
    parentMessageIdstringrequired

    MessageId родительского сообщения, к которому относится обсуждение

    Example: bIQffAsGia
    conference object

    Информация о чате конференции

    conferenceIdstringrequired

    Идентификатор конференции, к которой относится чат

    Example: dIQffAsGia
    userEvents object

    Информация о чате с персональными нотификациями

    ownerstringrequired

    MembershipId владельца

    Example: aIQffAsGia
    reactionToggledEvent object

    Уведомление о добавлении/удалении реакции на сообщение

    chatIdstringrequired

    Id чата, в котором содержится сообщение с реакцией

    Example: w:AIQffAsGi8
    messageIdstringrequired

    Message Id сообщения с реакцией

    Example: bIQffAsGia
    emojistringrequired

    Emoji в виде :+1:

    Example: :heart:
    reactedBystringrequired

    Membership Id участника, который поставил или убрал реакцию

    Example: ADK5NyCqIK
    wasSetbooleanrequired

    Если значение true - реакция была поставлена, в противном случае - убрана

    Example: true
    messageEditedEvent object

    Уведомление об изменении сообщения

    chatIdstringrequired

    Id чата, в котором содержится измененное сообщение

    Example: w:AIQffAsGi8
    messageIdstringrequired

    Message Id измененного сообщения

    Example: bIQffAsGia
    messageDeletedEvent object

    Уведомление об удалении сообщения

    chatIdstringrequired

    Id чата, в котором содержалось удаленное сообщение

    Example: w:AIQffAsGi8
    messageIdstringrequired

    Message Id удаленного сообщения

    Example: bIQffAsGia
    chatMemberJoinedEvent object

    Уведомление о новом участнике в чате

    chatIdstringrequired

    Id чата, в котором появился новый участник

    Example: w:AIQffAsGi8
    memberIdstringrequired

    Membership Id нового участника чата

    Example: ADK5NyCqIK
    chatMemberLeftEvent object

    Уведомление о том, что участник покинул чат

    chatIdstringrequired

    Id чата, который покинул частник

    Example: w:AIQffAsGi8
    memberIdstringrequired

    Membership Id участника, который покинул чат

    Example: ADK5NyCqIK
    chatMemberInvitedEvent object

    Уведомление о приглашении нового участника в чат

    chatIdstringrequired

    Id чата, в который пригласили нового участника

    Example: w:AIQffAsGi8
    memberIdstringrequired

    Membership Id приглашенного участника

    Example: ADK5NyCqIK
    inviterMemberIdstringrequired

    Membership Id пригласившего участника

    Example: ADK5NyCqIK
    chatMemberChangedRoleEvent object

    Уведомление об изменении роли участника в чате

    chatIdstringrequired

    Id чата, в котором содержалось удаленное сообщение

    Example: w:AIQffAsGi8
    memberIdstringrequired

    Membership Id нового участника чата

    Example: ADK5NyCqIK
    newRoleChatRole (string)required

    Новая роль участника

    Possible values: [MEMBER, ADMIN, OWNER]

    Example: ADMIN
    chatArchivedEvent object

    Уведомление об архивации чата

    chatIdstringrequired

    Id чата, который был архивирован

    Example: w:AIQffAsGi8
    chatUnarchivedEvent object

    Уведомление об разархивации чата

    chatIdstringrequired

    Id чата, который был разархивирован

    Example: w:AIQffAsGi8
    messageAction object

    Объект обновления - интерактивное действие с сообщением (нажатие кнопки)

    workspaceIdstringrequired

    Id рабочего пространства, в котором находится сообщение

    Example: AIQffAsGi8
    chatIdstringrequired

    Id чата, в котором находится сообщение

    Example: w:AIQffAsGi8
    messageIdstringrequired

    Id сообщения

    Example: gIQffAsGi8
    pressedButtonCommand object

    Команда кнопки, которая была нажата

    displayTextstringrequired

    Текст на кнопке

    Example: Нажмите на кнопку
    commandKeystringrequired

    Команда, пересылаемая при нажатии на кнопку

    Example: /button_pushed
    workspaceInvite object

    Объект обновления - приглашение в новое рабочее пространство

    workspaceIdstringrequired

    Id рабочего пространства, в которое был приглашен бот

    Example: AIQffAsGi8
    inviterNamestringrequired

    Имя участника, который отправил приглашение

    Example: Иванов Иван
    inviterEmailstringrequired

    E-mail участника, который отправил приглашение

    Example: ivanov@example.org
    Update
    {
    "updateId": 0,
    "message": {
    "workspaceId": "AIQffAsGi8",
    "chatId": "w:AIQffAsGi8",
    "messageId": "gIQffAsGi8",
    "messageType": "USER",
    "inReplyToMessageId": "gIQffAsGi8",
    "membershipId": "gIQffAsGi8",
    "createdAt": "2023-02-26T18:58:36.154+03:00",
    "updatedAt": "2024-02-26T18:58:36.154+03:00",
    "content": {
    "text": "Привет!",
    "fileIds": "[ADK5NyCqIK, BDK5NyCqIK]",
    "conferenceId": "gIQffAsGi8",
    "systemEvent": {
    "chatCreated": {
    "creatorMembershipId": "ADK5NyCqIK",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    },
    "chatConvertedToPrivate": {
    "initiatorMembershipId": "ADK5NyCqIK"
    },
    "membersJoined": {
    "inviterMembershipId": "ADK5NyCqIK",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    },
    "membersLeft": {
    "kickerMembershipId": "ADK5NyCqIK",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    },
    "chatRenamed": {
    "initiatorMembershipId": "ADK5NyCqIK",
    "newName": "Документация"
    }
    },
    "forwardedContent": {
    "sourceWorkspaceId": "AIQffAsGi8",
    "sourceChatId": "w:AIQffAsGi8",
    "forwardedMessages": [
    {}
    ]
    },
    "userEvent": {
    "conferenceMissed": {
    "conferenceId": "ADK5NyCqIK",
    "inviterMemberId": "ADK5NyCqIK",
    "conferenceTarget": {
    "channelCall": {
    "chatId": "w:AIQffAsGi8"
    },
    "watercooler": {
    "scope": "PUBLIC",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    }
    },
    "startedAt": "2023-02-26T18:58:36.154+03:00"
    },
    "conferenceDeclined": {
    "conferenceId": "ADK5NyCqIK",
    "inviterMemberId": "ADK5NyCqIK",
    "conferenceTarget": {
    "channelCall": {
    "chatId": "w:AIQffAsGi8"
    },
    "watercooler": {
    "scope": "PUBLIC",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    }
    },
    "startedAt": "2023-02-26T18:58:36.154+03:00"
    },
    "conferenceDirectInvite": {
    "conferenceId": "ADK5NyCqIK",
    "inviterMemberId": "ADK5NyCqIK",
    "conferenceTarget": {
    "channelCall": {
    "chatId": "w:AIQffAsGi8"
    },
    "watercooler": {
    "scope": "PUBLIC",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    }
    },
    "startedAt": "2023-02-26T18:58:36.154+03:00"
    },
    "conferenceAnnounce": {
    "conferenceId": "ADK5NyCqIK",
    "inviterMemberId": "ADK5NyCqIK",
    "conferenceTarget": {
    "channelCall": {
    "chatId": "w:AIQffAsGi8"
    },
    "watercooler": {
    "scope": "PUBLIC",
    "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
    }
    },
    "startedAt": "2023-02-26T18:58:36.154+03:00"
    },
    "chatMessageMention": {
    "chatId": "w:AIQffAsGi8",
    "chatMessage": {}
    }
    }
    },
    "reactions": [
    {
    "emoji": ":heart:",
    "count": "5"
    }
    ],
    "threadId": "t:AIQffAsGi8",
    "pinnedAt": "2024-02-26T18:58:36.154+03:00"
    },
    "notification": {
    "workspaceId": "AIQffAsGi8",
    "timestamp": "2024-02-26T18:58:36.154+03:00",
    "memberJoinedEvent": {
    "memberId": "ADK5NyCqIK"
    },
    "memberInvitedEvent": {
    "memberId": "ADK5NyCqIK"
    },
    "memberLeftEvent": {
    "memberId": "ADK5NyCqIK"
    },
    "memberChangedRoleEvent": {
    "memberId": "ADK5NyCqIK",
    "newRole": "ADMIN"
    },
    "chatCreatedEvent": {
    "chatId": "w:AIQffAsGi8",
    "metadata": {
    "personal": {
    "otherMembershipId": "aIQffAsGia"
    },
    "workspace": {
    "name": "Новости",
    "announce": "true",
    "chatType": "PUBLIC",
    "autoJoinNewMembers": "true",
    "description": "Новости компании",
    "memberCount": "5"
    },
    "thread": {
    "parentChatId": "w:aIQffAsGia",
    "parentMessageId": "bIQffAsGia"
    },
    "conference": {
    "conferenceId": "dIQffAsGia"
    },
    "userEvents": {
    "owner": "aIQffAsGia"
    }
    }
    },
    "reactionToggledEvent": {
    "chatId": "w:AIQffAsGi8",
    "messageId": "bIQffAsGia",
    "emoji": ":heart:",
    "reactedBy": "ADK5NyCqIK",
    "wasSet": "true"
    },
    "messageEditedEvent": {
    "chatId": "w:AIQffAsGi8",
    "messageId": "bIQffAsGia"
    },
    "messageDeletedEvent": {
    "chatId": "w:AIQffAsGi8",
    "messageId": "bIQffAsGia"
    },
    "chatMemberJoinedEvent": {
    "chatId": "w:AIQffAsGi8",
    "memberId": "ADK5NyCqIK"
    },
    "chatMemberLeftEvent": {
    "chatId": "w:AIQffAsGi8",
    "memberId": "ADK5NyCqIK"
    },
    "chatMemberInvitedEvent": {
    "chatId": "w:AIQffAsGi8",
    "memberId": "ADK5NyCqIK",
    "inviterMemberId": "ADK5NyCqIK"
    },
    "chatMemberChangedRoleEvent": {
    "chatId": "w:AIQffAsGi8",
    "memberId": "ADK5NyCqIK",
    "newRole": "ADMIN"
    },
    "chatArchivedEvent": {
    "chatId": "w:AIQffAsGi8"
    },
    "chatUnarchivedEvent": {
    "chatId": "w:AIQffAsGi8"
    }
    },
    "messageAction": {
    "workspaceId": "AIQffAsGi8",
    "chatId": "w:AIQffAsGi8",
    "messageId": "gIQffAsGi8",
    "pressedButtonCommand": {
    "displayText": "Нажмите на кнопку",
    "commandKey": "/button_pushed"
    }
    },
    "workspaceInvite": {
    "workspaceId": "AIQffAsGi8",
    "inviterName": "Иванов Иван",
    "inviterEmail": "ivanov@example.org"
    }
    }