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

MeInfo

Сведения о боте, в том числе список рабочих пространств, в которых состоит бот, а также информация о профиле бота

profile objectrequired

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

accountIdstringrequired

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

Example: AIQffAsGi8
emailstring

Почтовый адрес

Example: i.ivanov@example.ru
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
fullNamestring

Отображаемое имя

Example: Иванов Иван Иванович
accountTypeAccountType (string)required

Тип аккаунта

Possible values: [REGULAR, BOT, GUEST]

Example: REGULAR
accountDetails object

Дополнительные данные о пользователе

positionstring

Должность

Example: Аналитик
departmentstring

Департамент

Example: B2B
phoneNumberstring

Номер телефона

Example: 88001234567
locationAccountLocation (string)

Место нахождения

Possible values: [NOT_SET, OFFICE, HOME, VACATION]

Example: OFFICE
biostring

Краткая информация

Example: Не беспокоить после 20:00
statusstring

Статус

Example: В командировке
workspacesstring[]required

Массив из workspaceId, в которых состоит бот

Example: [ADK5NyCqIK, BDK5NyCqIK]
updateApiVersionintegerrequired

Версия API, через которую бот получает обновления по методу getUpdates или по вебхукам. Может быть 1 или 2

Example: 1
updateSettingsUpdateSetting (string)[]required

Настройки активны только при получении обновлений по API v2. Массив из UpdateSetting, которые получает бот. По умолчанию бот получает типы MESSAGE и WORKSPACE_INVITE

Possible values: [MESSAGE, MESSAGE_ACTION, NOTIFICATION, WORKSPACE_INVITE]

autoAcceptWorkspaceInvitesbooleanrequired

Настройка активна только при получении обновлений по API v2. Устанавливает, будет ли бот автоматически принимать приглашения в рабочие пространства. По умолчанию false

Default value: false
Example: false
memberships object[]

Массив membershipId бота в каждом воркспейсе. Позволяет боту узнать свой membershipId без отправки сообщений

  • Array [
    • workspaceIdstringrequired

    Идентификатор рабочего пространства

    Example: ADK5NyCqIK
    membershipIdstringrequired

    Идентификатор участника (membershipId) бота в данном рабочем пространстве

    Example: YKcsFqDNXk
  • ]
    • scope objectrequired

    Область видимости бота - определяет, в каких пространствах бот может работать

    typeBotScopeType (string)required

    Тип области видимости бота

    Possible values: [pub, org, ws]

    Example: org
    organizationIdstring

    Идентификатор организации (требуется для type=ORG)

    Example: AIQffAsGi8
    workspaceIdstring

    Идентификатор рабочего пространства (требуется для type=WS)

    Example: BIQffAsGi9
    MeInfo
    {
      "profile": {
        "accountId": "AIQffAsGi8",
        "email": "i.ivanov@example.ru",
        "createdAt": "2023-02-26T18:58:36.154+03:00",
        "updatedAt": "2024-02-26T18:58:36.154+03:00",
        "fullName": "Иванов Иван Иванович",
        "accountType": "REGULAR",
        "accountDetails": {
          "position": "Аналитик",
          "department": "B2B",
          "phoneNumber": "88001234567",
          "location": "OFFICE",
          "bio": "Не беспокоить после 20:00",
          "status": "В командировке"
        }
      },
      "workspaces": "[ADK5NyCqIK, BDK5NyCqIK]",
      "updateApiVersion": "1",
      "updateSettings": [
        "MESSAGE"
      ],
      "autoAcceptWorkspaceInvites": "false",
      "memberships": [
        {
          "workspaceId": "ADK5NyCqIK",
          "membershipId": "YKcsFqDNXk"
        }
      ],
      "scope": {
        "type": "org",
        "organizationId": "AIQffAsGi8",
        "workspaceId": "BIQffAsGi9"
      }
    }
    Последнее обновление