Bluesky Social (независимый издатель) (предварительная версия)

Спецификация конечных точек Bluesky Social. Включает конечные точки для soprocial взаимодействия, администратора, чата, ATProto и озона.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Дэн Романо
Адрес электронной почты dan.romano@swolcat.com
Метаданные соединителя
Publisher krautrocker
Веб-сайт https://docs.bsky.app/
Политика конфиденциальности https://example.com/privacy-policy
Категории Социальные медиа

Соединитель API Bluesky

  • **Этот настраиваемый соединитель позволяет приложениям Power Platform взаимодействовать с API Bluesky, поддерживая операции управления веб-каналами, беседами, уведомлениями, отправкой видео и данными учетной записи.

Издатель: Дэн Романо

Предпосылки

  • **Чтобы использовать этот соединитель, вам потребуется:

    • **Блюски счет.
    • **ДОСТУП API к Bluesky с паролем приложения.

Поддерживаемые операции

  • **Этот соединитель включает следующие операции:

Конечные точки канала

  • **GET /app.bsky.feed.getTimeline — получение записей временной шкалы пользователя.
  • **GET /app.bsky.feed.getFeed Извлекает записи из определенного веб-канала или тега.
  • **GET /app.bsky.feed.searchPosts Поиск записей, соответствующих запросу.
  • **GET /app.bsky.feed.getActorFeeds Get feeds, размещенные определенным субъектом.
  • **GET /app.bsky.feed.getActorLikes Get post, нравится определенному субъекту.
  • **GET /app.bsky.feed.getAuthorFeed Get post from a specific author's feed.
  • **GET /app.bsky.feed.getFeedGenerator Извлекает созданный веб-канал для пользователя.
  • **GET /app.bsky.feed.getFeedGenerators Извлекает метаданные обо всех генераторах веб-каналов.
  • **GET /app.bsky.feed.getFeedSkeleton Извлекает минимальную версию веб-канала.
  • **GET /app.bsky.feed.getListFeed Извлекает записи из определенного списка.
  • **GET /app.bsky.feed.getPosts Извлекает список определенных записей по идентификаторам.
  • **GET /app.bsky.feed.getPostThread Извлекает поток записей, связанных с определенной записью.
  • **GET /app.bsky.feed.getLikes Извлекает пользователей, которые любили определенную запись.
  • **GET /app.bsky.feed.getQuotes Извлекает записи, которые цитируют определенную запись.
  • **GET /app.bsky.feed.getRepostedBy Retrieve пользователей, которые перепостили определенную запись.
  • **GET /app.bsky.feed.getSuggestedFeedS Get предлагаемые веб-каналы для пользователя.
  • **POST /app.bsky.feed.sendInteractions Send interactions (например, repost) для записи.

Конечные точки субъекта

  • **GET /app.bsky.actor.getPreferences Извлекает предпочтения пользователя.
  • **GET /app.bsky.actor.getProfile Извлекает профиль конкретного пользователя.
  • **GET /app.bsky.actor.getProfiles Извлекает несколько профилей пользователей.
  • **GET /app.bsky.actor.getSuggestions Извлекает предложения учетной записи для пользователя.
  • **POST /app.bsky.actor.putPreferences обновляет настройки пользователя.
  • **GET /app.bsky.actor.searchActors Поиск учетных записей пользователей по запросу.
  • **GET /app.bsky.actor.searchActorsTypeahead— получение предложений поиска для учетных записей пользователей.

Конечные точки Graph

  • **GET /app.bsky.graph.getActorStarterPacks Извлекает начальные пакеты учетных записей для нового пользователя.
  • **GET /app.bsky.graph.getKnownFollowers Get подписчиков, известных пользователю, прошедшему проверку подлинности.
  • **GET /app.bsky.graph.getFollowers Извлекает список подписчиков для пользователя.
  • **GET /app.bsky.graph.getFollows Извлекает пользователей, за которым следует конкретный пользователь.
  • **GET /app.bsky.graph.getBlocks Извлекает пользователей, заблокированных прошедшим проверку подлинности.
  • **GET /app.bsky.graph.getList Извлекает определенный список пользователей.
  • **GET /app.bsky.graph.getLists Извлекает все списки для прошедшего проверку подлинности пользователя.
  • **GET /app.bsky.graph.getListBlocks Извлекает пользователей, заблокированных в определенном списке.
  • **GET /app.bsky.graph.getListMutes Извлекает отключенные списки для прошедшего проверку подлинности пользователя.
  • **GET /app.bsky.graph.getMutes Извлекает отключенных пользователей.
  • **GET /app.bsky.graph.getRelationships Извлекает связи между прошедшим проверку подлинности пользователем и указанными учетными записями.
  • **GET /app.bsky.graph.getStarterPack Извлекает один начальный пакет для нового пользователя.
  • **GET /app.bsky.graph.getStarterPacks Извлекает все начальные пакеты для новых пользователей.
  • **GET /app.bsky.graph.getSuggestedFollowsByActor Get предлагаемые учетные записи, отфильтрованные субъектом.
  • **POST /app.bsky.graph.muteActor Отключить определенный субъект.
  • **POST /app.bsky.graph.unmuteActor Unmuteor определенный субъект.
  • **POST /app.bsky.graph.muteActorList Отключить определенный список субъектов.
  • **POST /app.bsky.graph.unmuteActorList Unmute List unmute list of actors.
  • **POST /app.bsky.graph.muteThread Отключить весь поток записей.
  • **POST /app.bsky.graph.unmuteThread Unmute Весь поток записей.

Конечные точки метки

  • **GET /app.bsky.labeler.getServices Извлекает список служб меток, доступных пользователю.

Конечные точки уведомлений

  • **GET /app.bsky.notification.getUnreadCount Извлекает количество непрочитанных уведомлений.
  • **GET /app.bsky.notification.listNotifications List Notifications List notifications для прошедшего проверку подлинности пользователя.
  • **POST /app.bsky.notification.putPreferences Update Notification настройки.
  • **POST /app.bsky.notification.registerPush Register for push notifications.
  • **POST /app.bsky.notification.updateSeen Mark notifications, как показано.

Конечные точки видео

  • **GET /app.bsky.video.getJobStatus Извлекает состояние задания отправки видео.
  • **GET /app.bsky.video.getUploadLimits Извлекает ограничения отправки видео для пользователя.
  • **POST /app.bsky.video.uploadVideo Upload a video file.

chat.bsky Конечные точки

  • **DELETE /chat.bsky.actor.deleteAccount Безвозвратно удалите учетную запись субъекта и связанные данные.
  • **GET /chat.bsky.actor.exportAccountData Export data for a specific actor.
  • **DELETE /chat.bsky.convo.deleteMessageForSelf Delete сообщение только из представления пользователя.
  • **GET /chat.bsky.convo.getConvo Извлекает определенную беседу.
  • **GET /chat.bsky.convo.getConvoForMembers Получает беседу между определенными членами.
  • **GET /chat.bsky.convo.getLog Извлекает журнал беседы.
  • **GET /chat.bsky.convo.getMessages Извлекает сообщения в беседе.
  • **POST /chat.bsky.convo.leaveConvo Оставьте беседу.
  • **GET /chat.bsky.convo.listConvos List all conversations для пользователя.
  • **POST /chat.bsky.convo.muteConvo Mute Notificatione для беседы.
  • **POST /chat.bsky.convo.sendMessage Send a message in a conversation.
  • **POST /chat.bsky.convo.sendMessageBatch Отправляет несколько сообщений в пакете.
  • **POST /chat.bsky.convo.unmuteConvo Unmute notifications for a conversation.
  • **POST /chat.bsky.convo.updateRead Mark беседу как прочитанное.
  • **GET /chat.bsky.moderation.getActorMetadata Get метаданные, связанные с состоянием модерации субъекта.
  • **GET /chat.bsky.moderation.getMessageContext Retrieve context для модерации сообщения.
  • **POST /chat.bsky.moderation.updateActorAccess Update разрешения доступа для указанного субъекта.

com.atproto.admin Конечные точки

  • **DELETE /com.atproto.admin.deleteAccount Безвозвратно удалите учетную запись.
  • **POST /com.atproto.admin.disableAccountInvites Disable invites for a account.
  • **POST /com.atproto.admin.disableInviteCodes Disable invite code.
  • **POST /com.atproto.admin.enableAccountInvites Enable invites for an account.
  • **GET /com.atproto.admin.getAccountInfo Get information about a specific account.
  • **GET /com.atproto.admin.getAccountInfos Извлекает сведения о нескольких учетных записях.
  • **GET /com.atproto.admin.getInviteCodes Извлекает коды приглашений для учетной записи.
  • **GET /com.atproto.admin.getSubjectStatus Get status information for a subject.
  • **GET /com.atproto.admin.searchAccounts Search для учетных записей.
  • **POST /com.atproto.admin.sendEmail Отправить сообщение электронной почты в учетную запись.
  • **POST /com.atproto.admin.updateAccountEmail Update адрес электронной почты, связанный с учетной записью.
  • **POST /com.atproto.admin.updateAccountHandle Обновите дескриптор, связанный с учетной записью.
  • **POST /com.atproto.admin.updateAccountPassword Обновите пароль для учетной записи.
  • **POST /com.atproto.admin.updateSubjectStatus Update status for a subject.

com.atproto.identity Конечные точки

  • **GET /com.atproto.identity.getRecommendedDidCredentials Извлекает рекомендуемые учетные данные DID.
  • **POST /com.atproto.identity.requestPlcOperationSignature Запрос подписи для операции PLC.
  • **GET /com.atproto.identity.resolveHandle Разрешить дескриптор учетной записи.
  • **POST /com.atproto.identity.signPlcOperation подписать операцию PLC.
  • **POST /com.atproto.identity.submitPlcOperation Отправить операцию PLC.
  • **POST /com.atproto.identity.updateHandle Обновите дескриптор удостоверения.

com.atproto.label Конечные точки

  • **GET /com.atproto.label.queryLabels Query label для содержимого или субъектов.

com.atproto.moderation Конечные точки

  • **POST /com.atproto.moderation.createReport Создайте отчет для модерации.
  • **GET /com.atproto.moderation.getActorMetadata Извлекает метаданные в целях модерации.

com.atproto.repo Конечные точки

  • **POST /com.atproto.repo.applyWrites Apply writes to a репозиторий.
  • **POST /com.atproto.repo.createRecord Create a record in a репозиторий.
  • **DELETE /com.atproto.repo.deleteRecord Delete a record from a репозиторий.
  • **GET /com.atproto.repo.describeRepo Описание репозитория.
  • **GET /com.atproto.repo.getRecord Извлекает запись по идентификатору.
  • **POST /com.atproto.repo.importRepo Import data в репозиторий.
  • **GET /com.atproto.repo.listMissingBlobs List отсутствующих BLOB-объектов.
  • **GET /com.atproto.repo.listRecords List все записи в репозитории.
  • **POST /com.atproto.repo.putRecord Update запись в репозитории.
  • **POST /com.atproto.repo.uploadBlob Upload a binary BLOB-объект в репозиторий.

com.atproto.server Конечные точки

  • **POST /com.atproto.server.activateAccount Активировать учетную запись.
  • **GET /com.atproto.server.checkAccountStatus Check account status.
  • **POST /com.atproto.server.confirmEmail Подтвердите адрес электронной почты.
  • **POST /com.atproto.server.createAccount Create a new account.
  • **POST /com.atproto.server.createAppPassword Создайте пароль для конкретного приложения.
  • **POST /com.atproto.server.createInviteCode Create a single invite code.
  • **POST /com.atproto.server.createInviteCodes Создайте несколько кодов приглашений.
  • **POST /com.atproto.server.createSession Create a session.
  • **POST /com.atproto.server.деактивацияAccount Деактивирует учетную запись.
  • **DELETE /com.atproto.server.deleteAccount Безвозвратно удалите учетную запись.
  • **DELETE /com.atproto.server.deleteSession Delete a session.
  • **GET /com.atproto.server.describeServer Describe server information.
  • **GET /com.atproto.server.getAccountInviteCodes Извлекает коды приглашений для учетной записи.
  • **GET /com.atproto.server.getServiceAuth Извлекает сведения о проверке подлинности службы.
  • **GET /com.atproto.server.getSession Get Session information.
  • **GET /com.atproto.server.listAppPasswords List passwords.
  • **POST /com.atproto.server.refreshSession Обновить сеанс.
  • **POST /com.atproto.server.requestAccountDelete Request удаление учетной записи.
  • **POST /com.atproto.server.requestEmailConfirmation Request подтверждение электронной почты.
  • **POST /com.atproto.server.requestEmailUpdate Request update.
  • **POST /com.atproto.server.requestPasswordReset Request reset.
  • **POST /com.atproto.server.reserveSigningKey Зарезервировать ключ подписи.
  • **POST /com.atproto.server.resetPassword Reset password.
  • **POST /com.atproto.server.revokeAppPassword Отменяет пароль для конкретного приложения.
  • **POST /com.atproto.server.updateEmail обновите сообщение электронной почты, связанное с учетной записью.

com.atproto.sync Конечные точки

  • **GET /com.atproto.sync.getBlob Извлекает большой двоичный объект по идентификатору.
  • **GET /com.atproto.sync.getBlocks Извлекает блоки по идентификатору.
  • **GET /com.atproto.sync.getLatestCommit Get the latest commit.
  • **GET /com.atproto.sync.getRecord Извлекает запись для синхронизации.
  • **GET /com.atproto.sync.getRepo Извлекает данные репозитория для синхронизации.
  • **GET /com.atproto.sync.getRepoStatus Retrieve status репозитория.
  • **GET /com.atproto.sync.listBlobs List Blobs List в репозитории.
  • **GET /com.atproto.sync.listRepos List репозитории для синхронизации.
  • **POST /com.atproto.sync.notifyOfUpdate Notify о обновлении в системе.
  • **POST /com.atproto.sync.requestCrawl Запрос обхода для синхронизации.

tools.ozone.communication Конечные точки

  • **POST /tools.ozone.communication.createTemplate Create a communication template.
  • **DELETE /tools.ozone.communication.deleteTemplate Delete a communication template.
  • **GET /tools.ozone.communication.listTemplates List Communication templates.
  • **POST /tools.ozone.communication.updateTemplate Update a communication template.

tools.ozone.moderation Конечные точки

  • **POST /tools.ozone.moderation.emitEvent Emit a moderation event.
  • **GET /tools.озон.moderation.getEvent Извлекает определенное событие модерации.
  • **GET /tools.озон.moderation.getRecord Извлекает запись модерации.
  • **GET /tools.ozone.moderation.getRecords List moderation records.
  • **GET /tools.ozone.moderation.getRepo Get Moderation information for a репозиторий.
  • **GET /tools.ozone.moderation.getRepos Get Moderation data for multiple repositories.
  • **GET /tools.ozone.moderation.queryEvents Query moderation events.
  • **GET /tools.ozone.moderation.queryStatuses Query moderation statuses.
  • **POST /tools.ozone.moderation.searchRepos Search репозитории для модерации.

tools.ozone.server Конечные точки

  • **GET /tools.ozone.server.getConfig Get Server. Получение сведений о конфигурации сервера.

tools.ozone.set Конечные точки

  • **POST /tools.ozone.set.addValues Добавьте значения в набор.
  • **DELETE /tools.ozone.set.deleteSet Delete a указанный набор.
  • **DELETE /tools.озон.set.deleteValues Удаляет определенные значения из набора.
  • **GET /tools.ozone.set.getValues Извлекает значения из набора.
  • **GET /tools.ozone.set.querySets Query set на основе фильтров.
  • **POST /tools.ozone.set.upsertSet Create or update a set.

tools.ozone.signature Конечные точки

  • **GET /tools.озон.signature.findCorrelation Find корреляции, связанные с сигнатурой.
  • **GET /tools.ozone.signature.findRelatedAccounts Find accounts, связанные с подписью.
  • **GET /tools.ozone.signature.searchAccounts Search for accounts by signature.

tools.ozone.team Конечные точки

  • **POST /tools.ozone.team.addMember Добавьте участника в команду.
  • **DELETE /tools.ozone.team.deleteMember Удалите участника из команды.
  • **GET /tools.ozone.team.listMembers List участников команды.
  • **POST /tools.ozone.team.updateMember Update. Сведения о члене команды.

Неподспекированные конечные точки

  • **POST /app.bsky.unspecced.uploadBlob Upload a binary BLOB-объект в учетную запись пользователя.
  • **GET /app.bsky.unspecced.getBlob Извлекает двоичный BLOB-объект из учетной записи пользователя.

Получение учетных данных

  • Перейдите на портал разработчика Bluesky.
  • Создайте пароль приложения в разделе "Параметры учетной записи".
  • Сохраните пароль приложения для использования в настройке соединителя.

Начало работы

  • **Для некоторых конечных точек требуются определенные параметры (например, идентификаторы субъектов или пользователей).

    • **Проверка подлинности: начните с проверки подлинности с учетными данными Bluesky.
    • **Выберите конечную точку: выберите нужную конечную точку, например получение веб-канала или уведомления о перечислении.
    • **Задать параметры: укажите необходимые параметры, такие как идентификаторы пользователей, ограничения или строки запроса.
    • **Выполнение запроса: запустите запрос, чтобы получить данные или выполнить действия в приложении Power Platform.

Известные проблемы и ограничения

Часто задаваемые вопросы

  • Вопрос. Как создать пароль приложения?
    Ответ. Посетите портал разработчика Bluesky и создайте новый пароль приложения. Используйте пароль для создания маркера.

  • Вопрос. Каковы ограничения скорости API?
    Ответ. Bluesky вводит ограничение скорости в 100 запросов в минуту на учетную запись.

  • Вопрос. Каковы некоторые полезные термины и определения, такие как субъект или ДИ?
    A: Полезные термины, которые необходимо знать:

    • Актёр: Сущность, как правило, пользователь, взаимодействующий с системой. Это может представлять человека, организацию или автоматическую систему.
    • Начальный пакет: Проверенный набор предлагаемых учетных записей или содержимого, предназначенный для того, чтобы помочь новым пользователям приступить к работе на платформе.
    • Подпись: Шифрование, используемое для проверки подлинности и целостности транзакции или операции в системе.
    • PLC (личная связанная цепочка): Структура, похожая на блокчейн, используемая для поддержания проверяемой истории операций с учетной записью (например, обработка обновлений, смена ключей). Это обеспечивает прозрачность и надежность.
    • DID (децентрализованный идентификатор): Глобальный уникальный идентификатор для субъекта, который не привязан к централизованному реестру. DID являются фундаментальными для децентрализованной природы Bluesky.

Support

  • **dan.romano@swolcat.com или torin@imp.sh (исходный владелец)

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

GetRecommendedDidCredentials

Описать учетные данные, которые следует включить в документ DID учетной записи, которая переносится в эту службу.
RequestPlcOperationSignature

Запросите сообщение электронной почты с кодом, чтобы запросить подписанную операцию PLC.
ResolveHandle

Разрешает дескриптор (доменное имя) в DID.
SignPlcOperation

Подписывает операцию PLC для обновления некоторых значений в документе DID запроса.
SubmitPlcOperation

Проверяет операцию PLC, чтобы убедиться, что она не нарушает ограничения службы.
Unmute Actor

Отменяет указанную учетную запись.
UpdateHandle

Обновляет дескриптор текущей учетной записи. Проверяет допустимость и обновляет документ:plc при необходимости.
Активация учетной записи

Активирует деактивированную учетную запись.
Включение приглашений учетной записи

Повторно включите возможность учетной записи получать коды приглашений.
Вывод списка CID BLOB-объектов учетной записи

Вывод списка CID BLOB-объектов учетной записи после редакции репозитория.
Вывод списка всех членов с доступом к озоновой службе

Перечислить всех членов с доступом к озоновой службе.
Вывод списка записей в репозитории

Список диапазонов записей в репозитории, соответствующий определенной коллекции.
Вывод списка паролей приложений

Список всех паролей приложений.
Вывод списка репозиториев

Перечисляет все CID, ред. и фиксацию CID для всех репозиториев
Выполнение действия модерации для субъекта

Выполнение действия модерации для субъекта
Деактивация учетной записи

Деактивирует текущую активную учетную запись после завершения миграции.
Добавление значений в набор

Добавьте значения в определенный набор.
Добавление участника группы

Добавьте участника в группу озона.
Доступные наборы запросов

Доступные наборы запросов.
Запись репозитория

Напишите запись репозитория, создайте или обновив ее по мере необходимости.
Запрос обновления электронной почты

Запрос маркера для обновления электронной почты.
Запрос сброса пароля

Инициируйте сброс пароля учетной записи пользователя по электронной почте.
Зарезервировать ключ подписи

Зарезервировать ключ подписи репозитория для использования с созданием учетной записи.
Импорт репозитория в виде CAR-файла

Импортируйте репозиторий в виде ФАЙЛА CAR. Обязательный заголовок Content-Length.
Настройка параметров уведомлений

Задайте параметры, связанные с уведомлениями для учетной записи.
Настройка параметров учетной записи

Задайте частные настройки, подключенные к учетной записи.
Начать разговор

Получите беседу на основе предоставленного идентификатора беседы.
Обновление дескриптора учетной записи

Административное действие для обновления дескриптора учетной записи.
Обновление доступа к субъекту

Обновите разрешения доступа субъекта.
Обновление пароля учетной записи

Обновите пароль для учетной записи пользователя от имени администратора.
Обновление сеанса проверки подлинности

Обновите сеанс проверки подлинности, чтобы получить новый маркер доступа и маркер обновления.
Обновление состояния субъекта

Обновите состояние администратора конкретной службы субъекта.
Обновление состояния чтения беседы

Обновите элемент в беседе, чтобы пометить его как прочитанное.
Обновление существующего шаблона связи

Административное действие для обновления существующего шаблона связи.
Обновление электронной почты

Обновление электронной почты учетной записи.
Обновление электронной почты учетной записи

Административное действие для обновления электронной почты учетной записи.
Обновление элемента в озоновой службе

Обновите элемент в озоновой службе.
Обход запроса

Запросите службу для постоянного обхода размещенных репозиториев.
Описание сервера

Описывает требования и возможности создания учетной записи сервера.
Оставьте беседу

Оставьте беседу, указав его идентификатор.
Отзыв пароля приложения

Отмена пароля приложения по имени.
Отключение беседы

Отключить беседу.
Отключение кодов приглашений

Отключите определенные коды приглашений, чтобы предотвратить дальнейшее использование.
Отключение потока

Отключает поток, предотвращающий уведомления из потока и любого из его дочерних элементов.
Отключение субъекта

Создает связь отключения для указанной учетной записи.
Отмена беседы

Отмените беседу.
Отмена потока

Отменяет указанный поток.
Отправка взаимодействий

Отправка сведений о взаимодействии.
Отправка видео

Отправьте видео для обработки и хранения в PDS.
Отправка нового большого двоичного объекта

Отправьте новый большой двоичный объект.
Отправка пакетных сообщений

Отправьте пакет сообщений нескольким беседам.
Отправка сообщения

Отправьте одно сообщение в определенную беседу.
Отправка электронной почты на адрес электронной почты учетной записи пользователя

Отправьте сообщение электронной почты на адрес электронной почты учетной записи пользователя.
Перечисление событий модерации, связанных с темой

Вывод списка событий модерации, связанных с темой.
Перечисление уведомлений

Перечисление уведомлений для запрашивающей учетной записи.
Подсчет количества непрочитанных уведомлений для запрашивающей учетной записи

Подсчитывайте количество непрочитанных уведомлений для запрашивающей учетной записи.
Подтверждение электронной почты

Подтвердите сообщение электронной почты с помощью маркера, созданного процессом requestEmailConfirmation.
Подтверждение электронной почты

Запросите сообщение электронной почты с кодом, чтобы подтвердить владение электронной почтой.
Поиск записей

Найдите записи, соответствующие критериям поиска, возвращая представления этих записей.
Поиск корреляции подписей угроз

Найдите все коррелированные подписи угроз между 2 или более учетными записями.
Поиск меток, относящихся к предоставленным AT-URI шаблонам

Найдите метки, относящиеся к предоставленным AT-URI шаблонам.
Поиск репозиториев на основе поискового термина

Поиск репозиториев на основе поискового термина.
Поиск связанных учетных записей

Получение учетных записей, которые совместно используют некоторые соответствующие подписи угроз с корневой учетной записью.
Поиск субъектов (профилей) с соответствующими критериями поиска

Поиск субъектов (профилей) с соответствующими критериями поиска.
Поиск субъектов для Typeahead

Получение предложений учетной записи для поиска typeahead.
Поиск учетных записей

Получите список учетных записей, соответствующих поисковому запросу.
Получение Convo для членов

Получите беседу для одного или нескольких участников.
Получение блоков данных из репозитория

Получение блоков данных из заданного репозитория с помощью CID.
Получение большого двоичного объекта, связанного с учетной записью

Получение большого двоичного объекта, связанного с данной учетной записью.
Получение веб-канала

Получите гидратированный канал из выбранного генератора веб-каналов субъекта.
Получение веб-канала автора

Получите представление "автора веб-канала" субъекта.
Получение веб-канала списка

Получение веб-канала последних записей из списка.
Получение веб-каналов субъектов

Получение списка веб-каналов, созданных субъектом.
Получение временной шкалы

Получите представление домашней временной шкалы запрашивающей учетной записи.
Получение заблокированных списков

Получение списков мод, которые блокирует запрашивающая учетная запись (субъект).
Получение записей

Возвращает представления записей для указанного списка записей.
Получение записи из репозитория

Извлеките запись из репозитория по уникальному идентификатору.
Получение значений набора

Получение определенного набора и его значений.
Получение известных последователей

Получение подписчиков для определенной учетной записи, за которой также следует средство просмотра.
Получение кавычки

Получите список цитат для данной записи.
Получение кодов приглашений

Получение представления администраторов кодов приглашений.
Получение кодов приглашения учетной записи

Получите все коды приглашений для текущей учетной записи.
Получение контекста сообщения

Получение окружающих сообщений из беседы
Получение конфигурации сервера

Получение сведений о конфигурации сервера озона.
Получение маркера проверки подлинности службы

Получите подписанный маркер от имени запрашивающей службы DID.
Получение метаданных субъекта

Получение метаданных, связанных с модерациями для субъекта с помощью DID
Получение начального пакета

Возвращает представление начального пакета на основе предоставленной ссылки (AT-URI).
Получение начальных пакетов

Получите подробные представления для списка начальных пакетов на основе предоставленных URI.
Получение нравится

Получите такие записи, которые ссылаются на тему (по AT-URI и CID).
Получение общедоступных связей между одной учетной записью и списком других учетных записей

Получение общедоступных связей между одной учетной записью и списком других учетных записей.
Получение ограничений для отправки видео для прошедшего проверку подлинности пользователя

Получение ограничений для отправки видео для прошедшего проверку подлинности пользователя.
Получение одной записи из репозитория

Получение одной записи из репозитория.
Получение отключений

Перечисляет учетные записи, которые запрашивающая учетная запись в настоящее время отключена.
Получение отключенных списков

Получение списков модов о том, что запрашивающая учетная запись в настоящее время отключена.
Получение параметров

Получение частных настроек, присоединенных к текущей учетной записи.
Получение повторного отправки по

Получение списка репостов для данной записи.
Получение подписчиков

Перечислите учетные записи, которые соответствуют указанному субъекту.
Получение потока post

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

Получите список предлагаемых веб-каналов для запрашивающей учетной записи.
Получение предлагаемых следов за актером

Перечисления соответствуют заданной учетной записи.
Получение предлагаемых субъектов

Получите список предлагаемых субъектов.
Получение представления записей

Возвращает сведения о динамической схеме для представления записей.
Получение представления списка

Возвращает представление (с дополнительным контекстом) указанного списка.
Получение профилей

Получение подробных представлений профиля нескольких субъектов.
Получение репозиториев модерации

Получите список всех репозиториев модерации.
Получение сведений о веб-канале

Получение сведений о генераторе веб-каналов.
Получение сведений о генераторах веб-каналов

Получение сведений о списке генераторов веб-каналов.
Получение сведений о генераторе веб-каналов

Получение сведений о генераторе веб-каналов.
Получение сведений о записи

Получение сведений о записи.
Получение сведений о некоторых записях

Получение сведений о некоторых записях.
Получение сведений о репозитории

Получение сведений о репозитории.
Получение сведений о событии модерации

Получение сведений о событии модерации.
Получение сведений о состоянии задания обработки видео

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

Получение сведений о списке служб меток.
Получение сведений о текущем сеансе

Получение сведений о сеансе, прошедшем проверку подлинности.
Получение сведений об учетной записи

Получение сведений об учетной записи.
Получение сведений об учетной записи

Получение сведений о некоторых учетных записях.
Получение сведений об учетной записи и репозитории

Получение сведений об учетной записи и репозитории, включая список коллекций.
Получение скелета канала

Получение скелета канала, предоставляемого генератором веб-каналов.
Получение следующих сведений

Перечисляет учетные записи, которые следует указанному субъекту.
Получение сообщений

Получение списка сообщений из определенной беседы.
Получение состояния размещения репозитория

Получите состояние размещения для репозитория на этом сервере.
Получение списка записей, нравится субъекту

Получите список записей, которые нравится субъекту.
Получение списка начальных пакетов, созданных субъектом

Получите список начальных пакетов, созданных субъектом.
Получение списка шаблонов связи

Получите список всех доступных шаблонов связи.
Получение списков

Перечисляет списки, созданные указанной учетной записью.
Получение текущей фиксации репозитория

Получите текущий CID фиксации и редакцию указанного репозитория.
Получить лог

Получение журнала действий и сообщений в беседе.
Получить профиль

Получение подробного представления профиля субъекта с помощью их дескриптора или DID.
Применение операций записи репозитория

Примените пакетную транзакцию репозитория, создает, обновляет и удаляет.
Проверка состояния учетной записи

Возвращает состояние учетной записи, особенно в отношении импорта или восстановления.
Просмотр состояний модерации субъектов

Просмотр состояний модерации субъектов (запись или репозиторий).
Регистрация для получения push-уведомлений

Зарегистрируйтесь для получения push-уведомлений.
Сброс пароля

Сброс пароля учетной записи пользователя с помощью маркера.
Скачивание экспорта репозитория

Скачайте экспорт репозитория в виде CAR-файла.
Создание или обновление метаданных набора

Создание или обновление метаданных набора.
Создание кода приглашения

Создайте код приглашения для указанных вариантов использования.
Создание кодов приглашений

Создайте несколько кодов приглашений с указанными ограничениями использования.
Создание одной записи репозитория

Создайте одну запись репозитория.
Создание отчета

Отправьте отчет модерации относительно учетной записи или записи atproto. Реализуется службами модерации (с прокси-сервером PDS) и требует проверки подлинности.
Создание пароля приложения

Создайте пароль приложения.
Создание сеанса проверки подлинности

Создание сеанса проверки подлинности
Создание учетной записи

Создайте учетную запись с указанными сведениями.
Создание шаблона для повторного использования связи

Действие администратора для создания нового повторного использования шаблона.
Список бесед

Вывод списка бесед.
Список отсутствующих BLOB-объектов для запрашивающей учетной записи

Возвращает список отсутствующих BLOB-объектов для запрашивающей учетной записи.
Список субъектов unmute

Отменяет указанный список учетных записей.
Список субъектов выключения

Создает связь отключения для указанного списка учетных записей.
Уведомление об обновлении

Уведомите службу обхода данных о недавнем обновлении и о том, что обход должен возобновиться.
Уведомлять сервер о том, что запрашивающая учетная запись видела уведомления

Уведомите сервер о том, что запрашивающая учетная запись видела уведомления.
Удаление записи репозитория или обеспечение его не существует

Удалите запись репозитория или убедитесь, что она не существует.
Удаление значений из набора

Удаление значений из определенного набора.
Удаление набора

Удаление всего набора.
Удаление сеанса

Удалите текущий сеанс.
Удаление сообщения для самостоятельного выполнения

Удалите сообщение для пользователя, отправившего его.
Удаление участника из группы озона

Удалите члена из группы озона.
Удаление учетной записи

Удаление учетной записи пользователя от имени администратора.
Удаление учетной записи

Удалите учетную запись субъекта с маркером и паролем.
Удаление учетной записи

Удаление учетной записи.
Удаление учетной записи запроса

Инициируйте удаление учетной записи пользователя по электронной почте.
Удаление шаблона связи

Удалите шаблон связи по уникальному идентификатору.
Экспорт данных учетной записи

Экспорт данных учетной записи.

GetRecommendedDidCredentials

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

Описать учетные данные, которые следует включить в документ DID учетной записи, которая переносится в эту службу.

Возвращаемое значение

Имя Путь Тип Описание
rotationKeys
 rotationKeys array of string
такжеKnownAs
 alsoKnownAs array of string
authenticationMethods
 verificationMethods object
services
 services object

RequestPlcOperationSignature

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

Запросите сообщение электронной почты с кодом, чтобы запросить подписанную операцию PLC.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, был ли запрос успешным.

ResolveHandle

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

Разрешает дескриптор (доменное имя) в DID.

Параметры

Имя Ключ Обязательно Тип Описание
Дескриптор для разрешения.
 handle True string

Дескриптор для разрешения.

Возвращаемое значение

Имя Путь Тип Описание
делать
 did string

Разрешенный DID.

SignPlcOperation

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

Подписывает операцию PLC для обновления некоторых значений в документе DID запроса.

Параметры

Имя Ключ Обязательно Тип Описание
token
 token True string

Маркер, полученный через com.atproto.identity.requestPlcOperationSignature.
rotationKeys
 rotationKeys array of string
такжеKnownAs
 alsoKnownAs array of string
authenticationMethods
 verificationMethods object
services
 services object

Возвращаемое значение

Имя Путь Тип Описание
Операция
 operation object

SubmitPlcOperation

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

Проверяет операцию PLC, чтобы убедиться, что она не нарушает ограничения службы.

Параметры

Имя Ключ Обязательно Тип Описание
Операция
 operation True object

Операция PLC для проверки.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, была ли операция успешно проверена.

Unmute Actor

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

Отменяет указанную учетную запись.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Идентификатор (AT-identifier) субъекта для отмены.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

UpdateHandle

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

Обновляет дескриптор текущей учетной записи. Проверяет допустимость и обновляет документ:plc при необходимости.

Параметры

Имя Ключ Обязательно Тип Описание
ручка
 handle True string

Новый дескриптор.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, был ли дескриптор успешно обновлен.
сообщение
 message string

Дополнительные сведения об операции.

Активация учетной записи

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

Активирует деактивированную учетную запись.

Включение приглашений учетной записи

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

Повторно включите возможность учетной записи получать коды приглашений.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 account True string

Учетная запись или DID, для которой включены приглашения.
Причина включения
 note string

Необязательная причина включения приглашений.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.
сообщение
 message string

Необязательное сообщение, подробное описание результата.

Вывод списка CID BLOB-объектов учетной записи

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

Вывод списка CID BLOB-объектов учетной записи после редакции репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Репозиторий DID
 did True string

DID репозитория.
Исправление
 since string

Необязательная редакция репозитория для перечисления больших двоичных объектов с тех пор.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Cursor
 cursor string

Курсор разбиения на страницы для следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
cids
 cids array of string

Вывод списка всех членов с доступом к озоновой службе

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

Перечислить всех членов с доступом к озоновой службе.

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для результатов разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующей страницы результатов.
члены
 members array of member

Вывод списка записей в репозитории

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

Список диапазонов записей в репозитории, соответствующий определенной коллекции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор репозитория
 repo True string

Дескриптор или DID репозитория.
Тип сбора
 collection True string

NSID типа записи.
Ограничение результатов
 limit integer

Количество возвращаемых записей.
Курсор разбиения на страницы
 cursor string

Курсор для результатов разбиения на страницы.
Обратный порядок
 reverse boolean

Пометка для отмены порядка возвращаемых записей.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующей страницы результатов.
Записи
 records array of listRecords.record

Вывод списка паролей приложений

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

Список всех паролей приложений.

Возвращаемое значение

Имя Путь Тип Описание
Пароли
 passwords array of listAppPassword

Вывод списка репозиториев

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

Перечисляет все CID, ред. и фиксацию CID для всех репозиториев

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Cursor
 cursor string

Курсор разбиения на страницы для следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
repos
 repos array of listRepos.repo

Выполнение действия модерации для субъекта

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

Выполнение действия модерации для субъекта

Параметры

Имя Ключ Обязательно Тип Описание
событие
 event True string

Событие модерации для выдачи.
субъект
 subject True string

Тема события модерации.
subjectBlobCids
 subjectBlobCids array of string
создано кем
 createdBy True string

Возвращаемое значение

Тело
modEventView

Деактивация учетной записи

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

Деактивирует текущую активную учетную запись после завершения миграции.

Параметры

Имя Ключ Обязательно Тип Описание
deleteAfter
 deleteAfter date-time

Временное окно для хранения деактивированных учетных записей.

Добавление значений в набор

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

Добавьте значения в определенный набор.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string

Имя набора для добавления значений в
values
 values True array of string

Значения для добавления в набор

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

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

Добавьте участника в группу озона.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string

ПРИЛОЖЕНИЕ DID элемента, добавляемого.
роль
 role True string

Роль добавляемого члена.

Возвращаемое значение

Тело
member

Доступные наборы запросов

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

Доступные наборы запросов.

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых наборов.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы.
Префикс имени
 namePrefix string

Фильтрует наборы по префиксу имени.
Сортировка по полю
 sortBy string

Поле для сортировки результатов по.
Направление сортировки
 sortDirection string

Направление сортировки, по умолчанию — по возрастанию поля имени.

Возвращаемое значение

Имя Путь Тип Описание
sets
 sets array of setView
курсор
 cursor string

Запись репозитория

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

Напишите запись репозитория, создайте или обновив ее по мере необходимости.

Параметры

Имя Ключ Обязательно Тип Описание
репозиторий
 repo True string

Дескриптор репозитория (ака, текущая учетная запись).
коллекция
 collection True string

NSID коллекции записей.
rkey
 rkey True string

Ключ записи.
validate
 validate boolean

Значение true/false для пропуска проверки схемы Lexicon.
запись
 record True object

Содержимое записи.
swapRecord
 swapRecord string

Сравнение и переключение с предыдущей записью по CID.
swapCommit
 swapCommit string

Сравнение и переключение с предыдущей фиксацией с помощью CID.

Возвращаемое значение

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
фиксация
 commit commitMeta
validationStatus
 validationStatus string

Запрос обновления электронной почты

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

Запрос маркера для обновления электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
tokenRequired
 tokenRequired boolean

Указывает, требуется ли маркер для обновления электронной почты.

Запрос сброса пароля

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

Инициируйте сброс пароля учетной записи пользователя по электронной почте.

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
 email True string

Адрес электронной почты, связанный с учетной записью пользователя.

Зарезервировать ключ подписи

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

Зарезервировать ключ подписи репозитория для использования с созданием учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did string

Децентрализованный идентификатор (DID) для резервирования ключа подписи.

Возвращаемое значение

Имя Путь Тип Описание
ключ подписи
 signingKey string

Открытый ключ для зарезервированного ключа подписывания.

Импорт репозитория в виде CAR-файла

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

Импортируйте репозиторий в виде ФАЙЛА CAR. Обязательный заголовок Content-Length.

Параметры

Имя Ключ Обязательно Тип Описание
Сведения о ФАЙЛЕ CAR
 body True string

Файл CAR для импорта.

Возвращаемое значение

Имя Путь Тип Описание
сообщение
 message string

Сообщение об успешном выполнении, указывающее, что репозиторий импортирован.
repoId
 repoId string

Уникальный идентификатор импортированного репозитория.

Настройка параметров уведомлений

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

Задайте параметры, связанные с уведомлениями для учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
priority
 priority True boolean

Указывает, следует ли включить уведомления о приоритете.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.
сообщение
 message string

Необязательное сообщение об успешном выполнении.

Настройка параметров учетной записи

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

Задайте частные настройки, подключенные к учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
enabled
 enabled True boolean
labelerDid
 labelerDid string

К какой метки применяется этот параметр?
label
 label True string
видимость
 visibility True string
pinned
 pinned True array of string
Сохранено
 saved True array of string
временная шкалаIndex
 timelineIndex integer
id
 id True string
type
 type True string
value
 value True string
pinned
 pinned True boolean
birthDate
 birthDate date-time

Дата рождения владельца учетной записи.
корм
 feed True string

Универсальный код ресурса (URI) веб-канала или идентификатор, описывающий веб-канал.
hideReplies
 hideReplies boolean

Скрытие ответов в канале.
hideRepliesByUnfollowed
 hideRepliesByUnfollowed boolean

Скрытие ответов в веб-канале, если они не следуют пользователям.
hideRepliesByLikeCount
 hideRepliesByLikeCount integer
hideReposts
 hideReposts boolean

Скрытие репостов в веб-канале.
hideQuotePosts
 hideQuotePosts boolean

Скрытие записей кавычек в веб-канале.
sort
 sort string

Режим сортировки потоков.
prioritizeFollowedUsers
 prioritizeFollowedUsers boolean

Показывать пользователей в верхней части всех ответов.
tags
 tags True array of string
id
 id string
value
 value True string

Приглушенное слово.
targets
 targets string
actorTarget
 actorTarget string

Группы пользователей для применения отключаемого слова. Если не определено, применяется ко всем пользователям.
истекает срок действия
 expiresAt date-time

Дата и время истечения срока действия отключенного слова и больше не будет применено.
items
 items True array of string
гид
 guide True string
queuedNudges
 queuedNudges array of string
id
 id True string
завершено
 completed True boolean
данные
 data string

Произвольные данные для NUX. Ограничение в 300 символов.
истекает срок действия
 expiresAt date-time

Дата и время истечения срока действия NUX.
делать
 did True string

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.
сообщение
 message string

Необязательное сообщение об успешном выполнении.

Начать разговор

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

Получите беседу на основе предоставленного идентификатора беседы.

Параметры

Имя Ключ Обязательно Тип Описание
ID разговора
 convoId True string

Идентификатор извлекаемой беседы.

Возвращаемое значение

Имя Путь Тип Описание
Представление беседы
 convo convoView

Представляет представление беседы.

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

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

Административное действие для обновления дескриптора учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string

DID учетной записи.
ручка
 handle True string

Новый дескриптор для учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнено ли обновление успешно.
сообщение
 message string

Необязательное сообщение, предоставляющее дополнительные сведения.

Обновление доступа к субъекту

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

Обновите разрешения доступа субъекта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string
Разрешить доступ
 allowAccess True boolean
Идентификатор ссылки
 ref string

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, успешно ли выполнено обновление доступа.
сообщение
 message string

Необязательное сообщение, подробное описание результата.

Обновление пароля учетной записи

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

Обновите пароль для учетной записи пользователя от имени администратора.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string

Функция DID учетной записи для обновления.
пароль
 password True string

Новый пароль для учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.
сообщение
 message string

Дополнительные сведения о результатах операции.

Обновление сеанса проверки подлинности

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

Обновите сеанс проверки подлинности, чтобы получить новый маркер доступа и маркер обновления.

Параметры

Имя Ключ Обязательно Тип Описание
refreshJwt
 refreshJwt True string

Маркер обновления, предоставленный во время создания сеанса

Возвращаемое значение

Имя Путь Тип Описание
accessJwt
 accessJwt string

Маркер доступа JWT.
refreshJwt
 refreshJwt string

Маркер обновления JWT.
ручка
 handle string

Дескриптор пользователя.
делать
 did string

Децентрализованный идентификатор (DID).
didDoc
 didDoc object

Необязательный документ DID.
активный
 active boolean

Указывает, активен ли сеанс.
статус
 status string

Состояние размещения учетной записи.

Обновление состояния субъекта

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

Обновите состояние администратора конкретной службы субъекта.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string
УРИ
 uri True string

Универсальный код ресурса (URI) строгой ссылки.
cid
 cid True string

CID строгой ссылки.
делать
 did True string
cid
 cid True string
recordUri
 recordUri string
прикладной
 applied True boolean
ref
 ref string
прикладной
 applied True boolean
ref
 ref string

Возвращаемое значение

Имя Путь Тип Описание
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

Определяет надежную ссылку с помощью URI и CID.
repoBlobRef
 subject.repoBlobRef repoBlobRef
Демонтаж
 takedown statusAttr

Обновление состояния чтения беседы

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

Обновите элемент в беседе, чтобы пометить его как прочитанное.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string

Идентификатор беседы.
идентификатор сообщения
 messageId string

Идентификатор сообщения для пометки как прочитанного.

Возвращаемое значение

Имя Путь Тип Описание
Представление беседы
 convo convoView

Представляет представление беседы.

Обновление существующего шаблона связи

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

Административное действие для обновления существующего шаблона связи.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Идентификатор обновляемого шаблона.
имя
 name string

Имя шаблона.
lang
 lang string

Язык сообщений.
contentMarkdown
 contentMarkdown string

Содержимое шаблона, поддерживаемого markdown, может содержать заполнители переменных.
субъект
 subject string

Тема сообщения, используемого в сообщениях электронной почты.
обновленоBy
 updatedBy string

DID пользователя, который обновляет шаблон.
disabled
 disabled boolean

Отключается ли шаблон.

Возвращаемое значение

Тело
templateView

Обновление электронной почты

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

Обновление электронной почты учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
 email True string

Новый адрес электронной почты для обновления учетной записи.
emailAuthFactor
 emailAuthFactor boolean

Используется ли электронная почта в качестве фактора проверки подлинности.
token
 token string

Маркер из запросаEmailUpdate, если сообщение электронной почты учетной записи подтверждено.

Обновление электронной почты учетной записи

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

Административное действие для обновления электронной почты учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
account
 account True string

Дескриптор или DID репозитория.
электронная почта
 email True string

Новый адрес электронной почты для учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнено ли обновление успешно.
сообщение
 message string

Необязательное сообщение, предоставляющее дополнительные сведения.

Обновление элемента в озоновой службе

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

Обновите элемент в озоновой службе.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string

DID члена.
disabled
 disabled boolean

Указывает, отключен ли элемент.
роль
 role string

Роль, назначенная участнику.

Возвращаемое значение

Тело
member

Обход запроса

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

Запросите службу для постоянного обхода размещенных репозиториев.

Параметры

Имя Ключ Обязательно Тип Описание
hostname
 hostname True string

Имя узла текущей службы, запрашивающей обход.

Описание сервера

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

Описывает требования и возможности создания учетной записи сервера.

Возвращаемое значение

Имя Путь Тип Описание
inviteCodeRequired
 inviteCodeRequired boolean

Если задано значение true, необходимо предоставить код приглашения для создания учетной записи в этом экземпляре.
phoneVerificationRequired
 phoneVerificationRequired boolean

Если задано значение true, необходимо предоставить маркер проверки телефона для создания учетной записи в этом экземпляре.
availableUserDomains
 availableUserDomains array of string
links
 links describeServerLinks
контакт
 contact describeServerContact
делать
 did string

Децентрализованный идентификатор (DID) сервера.

Оставьте беседу

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

Оставьте беседу, указав его идентификатор.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string

Идентификатор оставить беседу.

Возвращаемое значение

Имя Путь Тип Описание
convoId
 convoId string

Идентификатор беседы, которая была оставлена.
оборот
 rev string

Идентификатор редакции беседы.

Отзыв пароля приложения

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

Отмена пароля приложения по имени.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string

Имя пароля приложения для отзыва.

Отключение беседы

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

Отключить беседу.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string

Идентификатор беседы, который необходимо отключить.

Возвращаемое значение

Имя Путь Тип Описание
Представление беседы
 convo convoView

Представляет представление беседы.

Отключение кодов приглашений

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

Отключите определенные коды приглашений, чтобы предотвратить дальнейшее использование.

Параметры

Имя Ключ Обязательно Тип Описание
inviteCodes
 inviteCodes array of string

Список кодов приглашений для отключения.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает успешное выполнение операции.

Отключение потока

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

Отключает поток, предотвращающий уведомления из потока и любого из его дочерних элементов.

Параметры

Имя Ключ Обязательно Тип Описание
Корневой универсальный код ресурса (URI)
 root True string

Ссылка на универсальный код ресурса (URI) на корневой каталог потока для отключения.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

Отключение субъекта

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

Создает связь отключения для указанной учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 actor True string

Идентификатор учетной записи, отключаемой.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

Отмена беседы

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

Отмените беседу.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string

Идентификатор беседы, который нужно отменить.

Возвращаемое значение

Имя Путь Тип Описание
Представление беседы
 convo convoView

Представляет представление беседы.

Отмена потока

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

Отменяет указанный поток.

Параметры

Имя Ключ Обязательно Тип Описание
URI корневого потока
 root True string

Универсальный код ресурса (URI) корневого потока для отмены.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

Отправка взаимодействий

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

Отправка сведений о взаимодействии.

Параметры

Имя Ключ Обязательно Тип Описание
item
 item string
событие
 event string
feedContext
 feedContext string

Контекст элемента веб-канала, первоначально предоставленный генератором веб-каналов в getFeedSkeleton.

Отправка видео

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

Отправьте видео для обработки и хранения в PDS.

Параметры

Имя Ключ Обязательно Тип Описание
Видеофайл
 file True file

Двоичный видеофайл для отправки и обработки.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Отправка нового большого двоичного объекта

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

Отправьте новый большой двоичный объект.

Параметры

Имя Ключ Обязательно Тип Описание
Отправка файла
 file True file

Файл БОЛЬШОго двоичного объекта для отправки.

Возвращаемое значение

Имя Путь Тип Описание
комок
 blob string

Переданный идентификатор большого двоичного объекта.

Отправка пакетных сообщений

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

Отправьте пакет сообщений нескольким беседам.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string
текст
 text True string
byteStart
 byteStart True integer

Начальный байт диапазона.
byteEnd
 byteEnd True integer

Конечный байт диапазона.
featureType
 featureType string

Тип функции.
details
 details object

Сведения о функции.
УРИ
 uri True string

Универсальный код ресурса (URI) строгой ссылки.
cid
 cid True string

CID строгой ссылки.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Отправка сообщения

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

Отправьте одно сообщение в определенную беседу.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string

Идентификатор беседы.
текст
 text True string
byteStart
 byteStart True integer

Начальный байт диапазона.
byteEnd
 byteEnd True integer

Конечный байт диапазона.
featureType
 featureType string

Тип функции.
details
 details object

Сведения о функции.
УРИ
 uri True string

Универсальный код ресурса (URI) строгой ссылки.
cid
 cid True string

CID строгой ссылки.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Отправка электронной почты на адрес электронной почты учетной записи пользователя

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

Отправьте сообщение электронной почты на адрес электронной почты учетной записи пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Получатель DID
 recipientDid True string

Децентрализованный идентификатор (DID) получателя.
Content
 content True string

Содержание электронного письма.
Тема
 subject string

Тема сообщения электронной почты.
Отправитель DID
 senderDid True string

DID отправителя.
Дополнительный комментарий
 comment string

Дополнительный комментарий отправителя, который не будет использоваться в самом сообщении электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
посылать
 sent boolean

Указывает, успешно ли отправлено сообщение электронной почты.

Перечисление событий модерации, связанных с темой

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

Вывод списка событий модерации, связанных с темой.

Параметры

Имя Ключ Обязательно Тип Описание
Тип события для фильтрации
 types array

Тип события для фильтрации по: defs#modEvent<name>
Кем создано:
 createdBy string

Создано пользователем
Порядок сортировки
 sortDirection string

Направление сортировки событий.
События, созданные после метки времени
 createdAfter date-time

Получение событий, созданных после заданной метки времени.
События, созданные до метки времени
 createdBefore date-time

Получение событий, созданных до заданной метки времени.
Тема
 subject string

Тема
Коллекция событий
 collections array

Возвращает события, в которых тема принадлежит заданной коллекции.
Тип темы
 subjectType string

Возвращает события, в которых субъект является учетной записью или записью.
Возвращает события всех типов
 includeAllUserRecords boolean

Возвращает события для всех типов записей из заданного парама "коллекции".
Лимит
 limit integer

Лимит
Имеет комментарий, да/нет
 hasComment boolean

Если значение true, возвращаются только события с комментариями.
Комментарий
 comment string

Возвращает события с комментариями, содержащими ключевое слово.
Добавление меток
 addedLabels array

Возвращает события, в которых возвращаются все эти метки.
События с удаленными метками
 removedLabels array

Возвращает события, в которых были удалены метки.
Удалены метки
 addedTags array

Возвращает события, в которых были удалены метки.
Удаленные теги
 removedTags array

Возвращает события, в которых были удалены теги.
Типы отчетов
 reportTypes array

Тип отчета для события модерации
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
events
 events array of modEventView

Перечисление уведомлений

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

Перечисление уведомлений для запрашивающей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Максимальное количество возвращаемых уведомлений.
Priority
 priority boolean

Фильтрация уведомлений по состоянию приоритета.
Cursor
 cursor string

Курсор разбиения на страницы для получения следующего набора уведомлений.
Видел в
 seenAt date-time

Фильтрация уведомлений, которые отображаются в указанное время даты или после нее.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
Уведомления
 notifications array of notification

Список уведомлений.
priority
 priority boolean

Указывает, включены ли уведомления о приоритете.
seenAt
 seenAt date-time

Метка времени, указывающая, когда уведомления были замечены в последний раз.

Подсчет количества непрочитанных уведомлений для запрашивающей учетной записи

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

Подсчитывайте количество непрочитанных уведомлений для запрашивающей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Priority
 priority boolean

Указывает, следует ли учитывать только высокоприоритетные уведомления.
Видел в
 seenAt date-time

Подсчет уведомлений, видимых после предоставленной метки времени.

Возвращаемое значение

Имя Путь Тип Описание
count
 count integer

Количество непрочитанных уведомлений.

Подтверждение электронной почты

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

Подтвердите сообщение электронной почты с помощью маркера, созданного процессом requestEmailConfirmation.

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
 email True string

Адрес электронной почты для подтверждения.
token
 token True string

Маркер подтверждения, отправленный пользователю по электронной почте.

Подтверждение электронной почты

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

Запросите сообщение электронной почты с кодом, чтобы подтвердить владение электронной почтой.

Поиск записей

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

Найдите записи, соответствующие критериям поиска, возвращая представления этих записей.

Параметры

Имя Ключ Обязательно Тип Описание
Поисковый запрос
 q True string

Строка запроса поиска.
Порядок сортировки
 sort string

Задает порядок ранжирования результатов.
С даты и времени
 since string

Фильтрация результатов для записей после указанного даты и времени (включительно).
До даты и времени
 until string

Отфильтруйте результаты для записей до указанного даты и времени (не включительно).
Учетная запись упоминаний
 mentions string

Отфильтруйте записи, которые упоминают указанную учетную запись.
Учетная запись автора
 author string

Фильтрация по записям по заданной учетной записи. Дескриптора разрешаются в DID до времени запроса.
Фильтр языка
 lang string

Фильтрация по записям на заданном языке.
Фильтр домена
 domain string

Отфильтруйте записи по URL-адресам.
Фильтр URL-адресов
 url string

Фильтрация по ссылкам.
Фильтр хэштега
 tag array

Фильтрация по записям с заданным тегом (хэштегом).
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Необязательный механизм разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
hitsTotal
 hitsTotal integer
posts
 posts array of postView

Поиск корреляции подписей угроз

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

Найдите все коррелированные подписи угроз между 2 или более учетными записями.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификаторы идентификаторов учетных записей
 dids True array

Список идентификаторов идентификаторов для учетных записей для поиска коррелированных подписей.

Возвращаемое значение

Имя Путь Тип Описание
details
 details array of sigDetail

Поиск меток, относящихся к предоставленным AT-URI шаблонам

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

Найдите метки, относящиеся к предоставленным AT-URI шаблонам.

Параметры

Имя Ключ Обязательно Тип Описание
Список шаблонов URI AT для сопоставления
 uriPatterns True array

Список шаблонов URI AT для сопоставления (логическое значение OR).
Идентификаторы DID для фильтрации
 sources array

Необязательный список источников меток (DID) для фильтрации.
Лимит
 limit integer

Максимальное количество возвращаемых меток.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для разбиения на страницы.
labels
 labels array of label

Поиск репозиториев на основе поискового термина

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

Поиск репозиториев на основе поискового термина.

Параметры

Имя Ключ Обязательно Тип Описание
Условие поиска
 q string

Поисковый термин для поиска репозиториев.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для результатов разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующей страницы результатов.
repos
 repos array of repoView

Поиск связанных учетных записей

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

Получение учетных записей, которые совместно используют некоторые соответствующие подписи угроз с корневой учетной записью.

Параметры

Имя Ключ Обязательно Тип Описание
Учетная запись DID
 did True string

DID корневой учетной записи.
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
accounts
 accounts array of findRelatedAccounts.relatedAccount

Поиск субъектов (профилей) с соответствующими критериями поиска

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

Поиск субъектов (профилей) с соответствующими критериями поиска.

Параметры

Имя Ключ Обязательно Тип Описание
Поисковый запрос
 q string

Строка запроса поиска. Синтаксис, фраза, логическое значение и аспекты не заданы, но рекомендуется использовать синтаксис запроса Lucene.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых субъектов.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы, чтобы получить следующий набор результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для разбиения на страницы.
Актеры
 actors array of profileView

Список соответствующих профилей субъектов.

Поиск субъектов для Typeahead

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

Получение предложений учетной записи для поиска typeahead.

Параметры

Имя Ключ Обязательно Тип Описание
Условие поиска
 q string

Термин поиска, используемый для результатов typeahead.
Лимит
 limit integer

Максимальное количество полученных результатов.

Возвращаемое значение

Имя Путь Тип Описание
Актеры
 actors array of appProfileViewBasic

Массив минимальных сведений о субъекте, соответствующий поиску typeahead.

Поиск учетных записей

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

Получите список учетных записей, соответствующих поисковому запросу.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес электронной почты для поиска.
 email string

Адрес электронной почты для поиска.
Курсор разбиения на страницы для следующих результатов.
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
Максимальное количество полученных результатов.
 limit integer

Максимальное количество полученных результатов

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для получения следующего набора результатов.
accounts
 accounts array of accountView

Список соответствующих учетных записей.

Получение Convo для членов

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

Получите беседу для одного или нескольких участников.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификаторы DID членов
 members True array

Список идентификаторов DID для членов беседы.

Возвращаемое значение

Имя Путь Тип Описание
Представление беседы
 convo convoView

Представляет представление беседы.

Получение блоков данных из репозитория

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

Получение блоков данных из заданного репозитория с помощью CID.

Параметры

Имя Ключ Обязательно Тип Описание
Репозиторий DID
 did True string

DID репозитория.
Блокировать CID
 cids True array

CID блоков для получения.

Возвращаемое значение

Имя Путь Тип Описание
Блоки
 blocks array of string

Список блоков, извлекаемых.

Получение большого двоичного объекта, связанного с учетной записью

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

Получение большого двоичного объекта, связанного с данной учетной записью.

Параметры

Имя Ключ Обязательно Тип Описание
Учетная запись DID
 did True string

DID учетной записи.
CID BLOB-объектов
 cid True string

Идентификатор CID большого двоичного объекта для получения.

Возвращаемое значение

Имя Путь Тип Описание
комок
 blob string

Содержимое большого двоичного объекта в кодировке Base64.

Получение веб-канала

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

Получите гидратированный канал из выбранного генератора веб-каналов субъекта.

Параметры

Имя Ключ Обязательно Тип Описание
Универсальный код ресурса (URI) генератора веб-каналов
 feed True string

Универсальный код ресурса (URI) генератора веб-каналов.
Идентификатор субъекта
 actor True string

Дескриптор или DID субъекта, запрашивающий веб-канал.
Лимит
 limit integer

Максимальное количество возвращаемых записей (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение веб-канала автора

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

Получите представление "автора веб-канала" субъекта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Идентификатор субъекта, веб-канал автора которого требуется получить.
Лимит
 limit integer

Максимальное количество элементов для получения.
Карозная разбивка на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.
Критерии фильтрации
 filter string

Сочетания типов post/repost для включения в ответ.
Включение закрепленных записей
 includePins boolean

Следует ли включать закрепленные записи в ответ.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
корм
 feed array of feedViewPost

Получение веб-канала списка

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

Получение веб-канала последних записей из списка.

Параметры

Имя Ключ Обязательно Тип Описание
Справочник по списку
 list True string

Ссылка (AT-URI) на запись списка.
Ограничение результатов
 limit integer

Максимальное количество записей для получения.
Курсор разбиения на страницы
 cursor string

Необязательный механизм разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
корм
 feed array of feedViewPost

Массив записей в веб-канале.

Получение веб-каналов субъектов

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

Получение списка веб-каналов, созданных субъектом.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Дескриптор или DID субъекта, веб-каналы которого необходимо извлечь.
Лимит
 limit integer

Максимальное количество возвращаемых веб-каналов (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение временной шкалы

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

Получите представление домашней временной шкалы запрашивающей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Вариант алгоритма
 algorithm string

Вариант "алгоритм" для временной шкалы.
Лимит
 limit integer

Максимальное количество возвращаемых записей (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение заблокированных списков

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

Получение списков мод, которые блокирует запрашивающая учетная запись (субъект).

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для получения следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для следующего набора результатов.
Списках
 lists array of listView

Получение записей

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

Возвращает представления записей для указанного списка записей.

Параметры

Имя Ключ Обязательно Тип Описание
Запись AT-URIs
 uris True array

Список постов AT-URIs для возврата гидратированных представлений.

Возвращаемое значение

Имя Путь Тип Описание
posts
 posts array of postView

Получение записи из репозитория

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

Извлеките запись из репозитория по уникальному идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
 did True string

Уникальный идентификатор записи.

Возвращаемое значение

Имя Путь Тип Описание
id
 record.id string

Уникальный идентификатор записи.
содержимое
 record.content string

Содержимое записи.

Получение значений набора

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

Получение определенного набора и его значений.

Параметры

Имя Ключ Обязательно Тип Описание
Задать имя
 name True string

Имя извлекаемого набора.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых значений.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
set
 set setView
values
 values array of string
курсор
 cursor string

Получение известных последователей

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

Получение подписчиков для определенной учетной записи, за которой также следует средство просмотра.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Дескриптор или ДИД субъекта, чьи последователи извлекаются.
Ограничение подписчиков
 limit integer

Максимальное число возвращаемых подписчиков (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение кавычки

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

Получите список цитат для данной записи.

Параметры

Имя Ключ Обязательно Тип Описание
URI ссылки на публикацию
 uri True string

Ссылка (AT-URI) записи записи.
Определяемая версия CID
 cid string

При указании фильтрует кавычки определенной версии (по CID) записи после публикации.
Ограничение результатов
 limit integer

Максимальное количество извлекаемых кавычек.
Курсор разбиения на страницы
 cursor string

Необязательный механизм разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
УРИ
 uri string

Ссылка (AT-URI) записи записи.
cid
 cid string

Конкретная версия (CID) записи после записи.
курсор
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
posts
 posts array of postView

Массив представлений post для кавычек.

Получение кодов приглашений

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

Получение представления администраторов кодов приглашений.

Параметры

Имя Ключ Обязательно Тип Описание
Метод сортировки
 sort string

Метод сортировки для кодов приглашений.
Лимит
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
Курсор для разбиения на страницы.
 cursor string
codes
 codes array of inviteCode

Получение кодов приглашения учетной записи

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

Получите все коды приглашений для текущей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Включение используемого
 includeUsed boolean

Включите в ответ используемые коды приглашений.
Создание доступной
 createAvailable boolean

Определяет, должны ли создаваться новые приглашения, но не созданные.

Возвращаемое значение

Имя Путь Тип Описание
codes
 codes array of inviteCode

Получение контекста сообщения

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

Получение окружающих сообщений из беседы

Параметры

Имя Ключ Обязательно Тип Описание
ИД разговора
 convoId string

Беседа с сообщением.
Идентификатор сообщения
 messageId True string

Идентификатор сообщения.
Число сообщений, которые необходимо включить до указанного сообщения.
 before integer

Число сообщений, которые необходимо включить до указанного сообщения.
Количество сообщений, которые необходимо включить после указанного сообщения.
 after integer

Количество сообщений, которые необходимо включить после указанного сообщения.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение конфигурации сервера

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

Получение сведений о конфигурации сервера озона.

Возвращаемое значение

Имя Путь Тип Описание
appview
 appview serviceConfig
pds
 pds serviceConfig
blobDivert
 blobDivert serviceConfig
чат
 chat serviceConfig
зритель
 viewer viewerConfig

Получение маркера проверки подлинности службы

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

Получите подписанный маркер от имени запрашивающей службы DID.

Параметры

Имя Ключ Обязательно Тип Описание
ДЕЛАТЬ
 aud True string

ФУНКЦИЯ DID службы, с помощью которую будет использоваться маркер для проверки подлинности.
Expiration
 exp integer

Время в секундах эпохи Unix, срок действия которого истекает JWT. Значения по умолчанию = 60 секунд
Метод Lexicon
 lxm string

Метод Lexicon (XRPC) для привязки запрошенного маркера к.

Возвращаемое значение

Имя Путь Тип Описание
token
 token string

Подписанный маркер проверки подлинности.

Получение метаданных субъекта

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

Получение метаданных, связанных с модерациями для субъекта с помощью DID

Параметры

Имя Ключ Обязательно Тип Описание
ДЕЛАТЬ
 actor True string

Децентрализованный идентификатор (DID) субъекта.

Возвращаемое значение

Имя Путь Тип Описание
day
 day ActorMetadata
month
 month ActorMetadata
all
 all ActorMetadata

Получение начального пакета

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

Возвращает представление начального пакета на основе предоставленной ссылки (AT-URI).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор начального пакета
 starterPack True string

Ссылка (AT-URI) записи начального пакета.

Возвращаемое значение

Имя Путь Тип Описание
starterPack
 starterPack starterPackView

Получение начальных пакетов

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

Получите подробные представления для списка начальных пакетов на основе предоставленных URI.

Параметры

Имя Ключ Обязательно Тип Описание
URI начального пакета
 uris True string

Список AT-URIs для начальных пакетов (не более 25 элементов).

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение нравится

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

Получите такие записи, которые ссылаются на тему (по AT-URI и CID).

Параметры

Имя Ключ Обязательно Тип Описание
AT-URI темы.
 uri True string

AT-URI темы (например, запись после записи).
CID записи субъекта.
 cid string

CID записи субъекта (определенная версия записи), чтобы отфильтровать нравится.
Ограничение количества результатов.
 limit integer

Лимит
Курсор разбиения на страницы.
 cursor string

Курсор разбиения на страницы

Возвращаемое значение

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
курсор
 cursor string
Любит
 likes array of getLikesLike

Получение общедоступных связей между одной учетной записью и списком других учетных записей

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

Получение общедоступных связей между одной учетной записью и списком других учетных записей.

Параметры

Имя Ключ Обязательно Тип Описание
Основная учетная запись
 actor True string

Основная учетная запись, запрашивающая связи.
Другие учетные записи
 others string

Список "других" учетных записей, которые должны быть связаны с основной.

Возвращаемое значение

Имя Путь Тип Описание
actor
 actor string

DID основной учетной записи.
relationships
 relationships array of object

Список связей между субъектом и другими учетными записями.
type
 relationships.type string

Тип связи или состояния.

Получение ограничений для отправки видео для прошедшего проверку подлинности пользователя

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

Получение ограничений для отправки видео для прошедшего проверку подлинности пользователя.

Возвращаемое значение

Имя Путь Тип Описание
canUpload
 canUpload boolean

Указывает, может ли пользователь отправлять видео.
оставшиесяDailyVideos
 remainingDailyVideos integer

Количество видео, которые пользователь может отправить сегодня.
остальныеDailyBytes
 remainingDailyBytes integer

Оставшийся размер данных в байтах, доступный для отправки сегодня.
сообщение
 message string

Дополнительные сведения об ограничениях отправки.
ошибка
 error string

Сообщение об ошибке, если применимо.

Получение одной записи из репозитория

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

Получение одной записи из репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Дескриптор или DID репозитория
 repo True string

Дескриптор или DID репозитория.
NSID коллекции записей
 collection True string

NSID коллекции записей.
Ключ записи
 rkey True string

Ключ записи.
CID версии записи
 cid string

Идентификатор CID версии записи.

Возвращаемое значение

Имя Путь Тип Описание
УРИ
 uri string

Универсальный код ресурса (URI) записи.
cid
 cid string

Идентификатор CID записи.
value
 value object

Значение записи.

Получение отключений

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

Перечисляет учетные записи, которые запрашивающая учетная запись в настоящее время отключена.

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для получения следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для следующего набора результатов.
отключение
 mutes array of profileView

Получение отключенных списков

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

Получение списков модов о том, что запрашивающая учетная запись в настоящее время отключена.

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для получения следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для следующего набора результатов.
Списках
 lists array of listView

Получение параметров

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

Получение частных настроек, присоединенных к текущей учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
preferences
 preferences preferences

Получение повторного отправки по

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

Получение списка репостов для данной записи.

Параметры

Имя Ключ Обязательно Тип Описание
URI ссылки на публикацию
 uri True string

Ссылка (AT-URI) записи записи.
Определяемая версия CID
 cid string

При указании фильтрует для перепостов определенной версии (по CID) записи после публикации.
Ограничение результатов
 limit integer

Максимальное количество репостов для получения.
Курсор разбиения на страницы
 cursor string

Необязательный механизм разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
УРИ
 uri string

Ссылка (AT-URI) записи записи.
cid
 cid string

Конкретная версия (CID) записи после записи.
курсор
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
repostedBy
 repostedBy array of profileView

Массив профилей, которые переместили запись.

Получение подписчиков

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

Перечислите учетные записи, которые соответствуют указанному субъекту.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Дескриптор или ДИД субъекта, чьи последователи извлекаются.
Ограничение разбиения на страницы
 limit integer

Максимальное число возвращаемых подписчиков (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение потока post

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

Получение записей в потоке.

Параметры

Имя Ключ Обязательно Тип Описание
Запись AT-URI
 uri True string

Ссылка (AT-URI) на запись.
Глубина ответа
 depth integer

Сколько уровней глубины ответа должно быть включено в ответ.
Родительские уровни постов
 parentHeight integer

Сколько уровней родительского (и бабушка и дедушка и т. д.) следует включить.

Возвращаемое значение

Имя Путь Тип Описание
статус
 thread.status string
threadgate
 threadgate threadgateView

Получение предлагаемых веб-каналов

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

Получите список предлагаемых веб-каналов для запрашивающей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Максимальное количество предлагаемых веб-каналов для возврата (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

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

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

Перечисления соответствуют заданной учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Actor
 actor True string

Идентификатор учетной записи, для которой предлагаются аналогичные инструкции.

Возвращаемое значение

Имя Путь Тип Описание
Предложения
 suggestions array of profileView

Список предлагаемых профилей для выполнения.
isFallback
 isFallback boolean

Указывает, являются ли результаты резервными универсальными предложениями.

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

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

Получите список предлагаемых субъектов.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Максимальное количество возвращаемых результатов.
Cursor
 cursor string

Курсор для разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующего набора результатов.
Актеры
 actors array of profileView

Список предлагаемых профилей субъектов.

Получение представления записей

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

Возвращает сведения о динамической схеме для представления записей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор записи
 recordId True string

Идентификатор записи.

Возвращаемое значение

Имя Путь Тип Описание
запись
 record object

Сведения о представлении записи.

Получение представления списка

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

Возвращает представление (с дополнительным контекстом) указанного списка.

Параметры

Имя Ключ Обязательно Тип Описание
Справочник по списку
 list True string

Ссылка (AT-URI) записи списка для гидратации.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор для разбиения на страницы
 cursor string

Курсор для получения следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для следующего набора результатов.
list
 list listView
items
 items array of listItemView

Получение профилей

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

Получение подробных представлений профиля нескольких субъектов.

Параметры

Имя Ключ Обязательно Тип Описание
Список идентификаторов субъектов
 actors True array

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

Возвращаемое значение

Имя Путь Тип Описание
profiles
 profiles array of profileViewDetailed

Получение репозиториев модерации

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

Получите список всех репозиториев модерации.

Возвращаемое значение

Имя Путь Тип Описание
repositories
 repositories array of object

Список репозиториев модерации.
id
 repositories.id string

Уникальный идентификатор репозитория.
статус
 repositories.status string

Состояние репозитория.

Получение сведений о веб-канале

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

Получение сведений о генераторе веб-каналов.

Возвращаемое значение

Имя Путь Тип Описание
делать
 did string
Каналы
 feeds array of describeFeedGeneratorFeed
links
 links describeFeedGeneratorLinks

Получение сведений о генераторах веб-каналов

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

Получение сведений о списке генераторов веб-каналов.

Параметры

Имя Ключ Обязательно Тип Описание
Список AT-URIs генератора веб-каналов
 feeds True array

Список AT-URIs, представляющих генераторы веб-каналов для получения сведений.

Возвращаемое значение

Имя Путь Тип Описание
Каналы
 feeds array of generatorView

Получение сведений о генераторе веб-каналов

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

Получение сведений о генераторе веб-каналов.

Параметры

Имя Ключ Обязательно Тип Описание
Генератор веб-каналов AT-URI
 feed True string

AT-URI записи генератора веб-каналов.

Возвращаемое значение

Имя Путь Тип Описание
view
 view generatorView
isOnline
 isOnline boolean

Указывает, подключена ли служба генератора веб-каналов в сети.
isValid
 isValid boolean

Указывает, совместима ли служба генератора веб-каналов с объявлением записи.

Получение сведений о записи

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

Получение сведений о записи.

Параметры

Имя Ключ Обязательно Тип Описание
Универсальный код ресурса (URI) записи для получения
 uri True string

Универсальный код ресурса (URI) записи.
CID конкретной версии
 cid string

Идентификатор CID версии записи.

Возвращаемое значение

Тело
recordViewDetail

Получение сведений о некоторых записях

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

Получение сведений о некоторых записях.

Параметры

Имя Ключ Обязательно Тип Описание
URI записей для получения
 uris True array

Список URI для записей.

Возвращаемое значение

Имя Путь Тип Описание
Записи
 records array of object
items
 records object

Получение сведений о репозитории

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

Получение сведений о репозитории.

Параметры

Имя Ключ Обязательно Тип Описание
DID репозитория
 did True string

DID репозитория.

Возвращаемое значение

Тело
repoViewDetail

Получение сведений о событии модерации

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

Получение сведений о событии модерации.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события модерации для получения
 id True integer

Идентификатор извлекаемого события модерации.

Возвращаемое значение

Тело
modEventViewDetail

Получение сведений о состоянии задания обработки видео

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

Получение сведений о состоянии задания обработки видео.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задания
 jobId True string

Идентификатор задания обработки видео для получения состояния.

Возвращаемое значение

Имя Путь Тип Описание
jobStatus
 jobStatus jobStatus

Получение сведений о списке служб меток

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

Получение сведений о списке служб меток.

Параметры

Имя Ключ Обязательно Тип Описание
DiDs
 dids True array

DiDs
Подробный
 detailed boolean

Подробный

Возвращаемое значение

Имя Путь Тип Описание
views
 views array of labelerView

Получение сведений о текущем сеансе

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

Получение сведений о сеансе, прошедшем проверку подлинности.

Возвращаемое значение

Имя Путь Тип Описание
ручка
 handle string

Дескриптор пользователя.
делать
 did string

Децентрализованный идентификатор (DID) пользователя.
электронная почта
 email string

Email адрес пользователя.
emailConfirmed
 emailConfirmed boolean

Указывает, подтверждает ли сообщение электронной почты.
emailAuthFactor
 emailAuthFactor boolean

Указывает, используется ли электронная почта в качестве фактора проверки подлинности.
didDoc
 didDoc object

Необязательный документ DID.
активный
 active boolean

Указывает, активен ли сеанс.
статус
 status string

Состояние учетной записи пользователя.

Получение сведений об учетной записи

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

Получение сведений об учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 did True string

Децентрализованный идентификатор (DID) учетной записи.

Возвращаемое значение

Тело
accountView

Получение сведений об учетной записи

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

Получение сведений о некоторых учетных записях.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификаторы учетных записей
 dids True array

Массив идентификаторов учетных записей (DID).

Возвращаемое значение

Имя Путь Тип Описание
сведения
 infos array of accountView

Получение сведений об учетной записи и репозитории

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

Получение сведений об учетной записи и репозитории, включая список коллекций.

Параметры

Имя Ключ Обязательно Тип Описание
Дескриптор или DID репозитория.
 repo True string

Дескриптор или DID репозитория.

Возвращаемое значение

Имя Путь Тип Описание
ручка
 handle string
делать
 did string
didDoc
 didDoc object
collections
 collections array of string
handleIsCorrect
 handleIsCorrect boolean

Указывает, является ли дескриптор допустимым в настоящее время.

Получение скелета канала

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Справочник по генератору веб-каналов.
 feed True string

Ссылка на запись генератора веб-каналов, описывающую запрашиваемый канал.
Количество полученных результатов.
 limit integer

Лимит
Курсор разбиения на страницы.
 cursor string

Курсор разбиения на страницы

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string
корм
 feed array of skeletonFeedPost

Получение следующих сведений

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

Перечисляет учетные записи, которые следует указанному субъекту.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Дескриптор или ДИД субъекта, следующего за которым извлекаются.
Максимальное количество учетных записей для получения
 limit integer

Максимальное количество возвращаемых учетных записей (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение сообщений

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

Получение списка сообщений из определенной беседы.

Параметры

Имя Ключ Обязательно Тип Описание
ID разговора
 convoId True string

Идентификатор беседы, из которого извлекаются сообщения.
Ограничение разбиения на страницы
 limit integer

Максимальное количество возвращаемых сообщений (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора сообщений.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение состояния размещения репозитория

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

Получите состояние размещения для репозитория на этом сервере.

Параметры

Имя Ключ Обязательно Тип Описание
Репозиторий DID
 did True string

DID репозитория.

Возвращаемое значение

Имя Путь Тип Описание
делать
 did string
активный
 active boolean
статус
 status string

Значение true или false, указывающее состояние действия.
оборот
 rev string

Необязательное поле, текущее изменение репозитория, если active=true

Получение списка записей, нравится субъекту

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

Получите список записей, которые нравится субъекту.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Идентификатор субъекта, чей люблю извлекается.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для следующей страницы результатов.
корм
 feed array of feedViewPost

Список записей, которые нравится субъекту.

Получение списка начальных пакетов, созданных субъектом

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

Получите список начальных пакетов, созданных субъектом.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Идентификатор субъекта, для которого требуется получить начальные пакеты.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых начальных пакетов.
Курсор разбиения на страницы
 cursor string

Курсор для разбиения на страницы, чтобы получить следующий набор результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для разбиения на страницы.
starterPacks
 starterPacks array of starterPackViewBasic

Получение списка шаблонов связи

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

Получите список всех доступных шаблонов связи.

Возвращаемое значение

Имя Путь Тип Описание
communicationTemplates
 communicationTemplates array of templateView

Получение списков

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

Перечисляет списки, созданные указанной учетной записью.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи
 actor True string

Учетная запись (субъект) для перечисления списков из.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для получения следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для следующего набора результатов.
Списках
 lists array of listView

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

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

Получите текущий CID фиксации и редакцию указанного репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Репозиторий DID
 did True string

DID репозитория.

Возвращаемое значение

Имя Путь Тип Описание
cid
 cid string
оборот
 rev string

Идентификатор редакции репозитория.

Получить лог

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

Получение журнала действий и сообщений в беседе.

Параметры

Имя Ключ Обязательно Тип Описание
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора журналов.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получить профиль

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

Получение подробного представления профиля субъекта с помощью их дескриптора или DID.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор субъекта
 actor True string

Дескриптор или DID учетной записи для получения профиля.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Применение операций записи репозитория

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

Примените пакетную транзакцию репозитория, создает, обновляет и удаляет.

Возвращаемое значение

Имя Путь Тип Описание
фиксация
 commit commitMeta
results
 results array of applyWrites.result

Проверка состояния учетной записи

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

Возвращает состояние учетной записи, особенно в отношении импорта или восстановления.

Возвращаемое значение

Имя Путь Тип Описание
активированный
 activated boolean

Указывает, активируется ли учетная запись.
validDid
 validDid boolean

Указывает, действительна ли функция DID.
repoCommit
 repoCommit string

Идентификатор фиксации для репозитория учетной записи.
repoRev
 repoRev string

Сведения о редакции репозитория.
репозитории
 repoBlocks integer

Количество блоков репозитория.
indexedRecords
 indexedRecords integer

Количество индексированных записей в учетной записи.
privateStateValues
 privateStateValues integer

Число значений частного состояния.
ожидаемые BLOB-объекты
 expectedBlobs integer

Ожидаемое количество больших двоичных объектов.
Импортированные BLOB-объекты
 importedBlobs integer

Количество импортированных BLOB-объектов.

Просмотр состояний модерации субъектов

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

Просмотр состояний модерации субъектов (запись или репозиторий).

Параметры

Имя Ключ Обязательно Тип Описание
Включение всех записей пользователей
 includeAllUserRecords boolean

Возвращает субъекты или субъекты из парам коллекций, принадлежащих указанной учетной записи.
Универсальный код ресурса (URI) субъекта
 subject string

Тема для получения состояния.
Ключевое слово "Комментарий"
 comment string

Поиск субъектов по ключевым словам из комментариев.
Сообщается после метки времени
 reportedAfter date-time

Субъекты поиска сообщили после заданной метки времени.
Сообщается до метки времени
 reportedBefore date-time

Субъекты поиска сообщили до заданной метки времени.
Просмотр после метки времени
 reviewedAfter date-time

Предметы поиска проверяются после заданной метки времени.
Просмотр до метки времени
 reviewedBefore date-time

Предметы поиска проверяются до заданной метки времени.
Размещение удалено после метки времени
 hostingDeletedAfter date-time

Предметы поиска, в которых связанная запись или учетная запись были удалены после метки времени.
Размещение удалено до метки времени
 hostingDeletedBefore date-time

Предметы поиска, в которых связанная запись или учетная запись были удалены до метки времени.
Размещение обновлено после метки времени
 hostingUpdatedAfter date-time

Предметы поиска, в которых связанная запись или учетная запись были обновлены после метки времени.
Размещение обновлено до метки времени
 hostingUpdatedBefore date-time

Предметы поиска, в которых связанная запись или учетная запись были обновлены до метки времени.
Состояние размещения
 hostingStatuses array

Поиск субъектов по состоянию связанной записи или учетной записи.
Включение отключенных тем
 includeMuted boolean

По умолчанию в результаты не включаются отключаемые темы.
Состояние проверки
 reviewState string

Укажите при получении субъектов в определенном состоянии.
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующей страницы результатов.
subjectStatuses
 subjectStatuses array of subjectStatusView

Регистрация для получения push-уведомлений

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

Зарегистрируйтесь для получения push-уведомлений.

Параметры

Имя Ключ Обязательно Тип Описание
serviceDid
 serviceDid True string

DID службы push-уведомлений.
token
 token True string

Маркер push-уведомлений.
платформа
 platform True string

Платформа для push-уведомлений.
appId (идентификатор приложения)
 appId True string

Идентификатор приложения, запрашивающего push-уведомления.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли регистрация успешно.

Сброс пароля

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

Сброс пароля учетной записи пользователя с помощью маркера.

Параметры

Имя Ключ Обязательно Тип Описание
token
 token True string

Маркер, предоставленный для сброса пароля.
пароль
 password True string

Новый пароль для учетной записи пользователя.

Скачивание экспорта репозитория

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

Скачайте экспорт репозитория в виде CAR-файла.

Параметры

Имя Ключ Обязательно Тип Описание
Репозиторий DID
 did True string

DID репозитория.
Исправление
 since string

Редакция репозитория ('rev') для создания диффа из.

Возвращаемое значение

response
binary

Создание или обновление метаданных набора

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

Создание или обновление метаданных набора.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string
описание
 description string

Возвращаемое значение

Тело
setView

Создание кода приглашения

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

Создайте код приглашения для указанных вариантов использования.

Параметры

Имя Ключ Обязательно Тип Описание
useCount
 useCount True integer

Количество раз, когда можно использовать код приглашения.
forAccount
 forAccount string

Учетная запись, для которой создается код приглашения.

Возвращаемое значение

Имя Путь Тип Описание
код
 code string

Созданный код приглашения.

Создание кодов приглашений

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

Создайте несколько кодов приглашений с указанными ограничениями использования.

Параметры

Имя Ключ Обязательно Тип Описание
codeCount
 codeCount True integer

Количество кодов приглашения для создания.
useCount
 useCount True integer

Количество раз, когда можно использовать каждый код приглашения.
forAccounts
 forAccounts array of string

Массив идентификаторов DID для учетных записей, для которых предназначены коды приглашения.

Возвращаемое значение

Имя Путь Тип Описание
codes
 codes array of object

Созданные коды приглашений.
account
 codes.account string

DID учетной записи, связанной с кодом приглашения.
код
 codes.code string

Созданный код приглашения.

Создание одной записи репозитория

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

Создайте одну запись репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
репозиторий
 repo True string

Дескриптор репозитория (ака, текущая учетная запись).
коллекция
 collection True string

NSID коллекции записей.
rkey
 rkey string

Ключ записи.
validate
 validate boolean

Значение true или false, заданное для пропуска проверки схемы Lexicon.
запись
 record True object

Объект записи.
swapCommit
 swapCommit string

Сравнение и переключение с предыдущей фиксацией с помощью CID.

Возвращаемое значение

Имя Путь Тип Описание
УРИ
 uri string

Универсальный код ресурса (URI) созданной записи.
cid
 cid string

Идентификатор CID созданной записи.
фиксация
 commit commitMeta
validationStatus
 validationStatus string

Создание отчета

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

Отправьте отчет модерации относительно учетной записи или записи atproto. Реализуется службами модерации (с прокси-сервером PDS) и требует проверки подлинности.

Параметры

Имя Ключ Обязательно Тип Описание
reasonSpam
 reasonSpam string

Спам: частое нежелательное продвижение, ответы, упоминания
reasonViolation
 reasonViolation string

Прямое нарушение правил сервера, законов, условий обслуживания
reasonMisleading
 reasonMisleading string

Вводящая в заблуждение личность, принадлежность или содержимое
reasonSexual
 reasonSexual string

Нежелательное или неправильное сексуальное содержимое
reasonRude
 reasonRude string

Грубое, харассирование, явное или в противном случае непристойное поведение
причинаOther
 reasonOther string

Другие: отчеты, не падающие под другую категорию отчета
reasonAppeal
 reasonAppeal string

Апелляция: обращение к ранее принятым мере модерации
причина
 reason string

Дополнительный контекст о содержимом и нарушении.
делать
 did True string
УРИ
 uri True string

Универсальный код ресурса (URI) строгой ссылки.
cid
 cid True string

CID строгой ссылки.

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Уникальный идентификатор отчета.
reasonType
 reasonType reasonType

Тип причины для отчета модерации. Одна из предопределенных причин.
причина
 reason string

Дополнительный контекст о содержимом и нарушении.
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

Определяет надежную ссылку с помощью URI и CID.
сообщаетBy
 reportedBy string

DID пользователя, отправившего отчет.
созданоВ
 createdAt date-time

Метка времени создания отчета.

Создание пароля приложения

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

Создайте пароль приложения.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string

Короткое имя для пароля приложения, чтобы помочь отличить их.
привилегированный
 privileged boolean

Если пароль приложения имеет привилегированный доступ к возможному состоянию конфиденциальной учетной записи. Предназначено для использования с доверенными клиентами.

Возвращаемое значение

Тело
createAppPassword

Создание сеанса проверки подлинности

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

Создание сеанса проверки подлинности

Параметры

Имя Ключ Обязательно Тип Описание
Host
 pdshost True string

Блюски хозяин
Имя пользователя
 identifier True string

Дескриптор или другой идентификатор
Пароль
 password True string

Пароль пользователя проверки подлинности
Маркер проверки подлинности
 authFactorToken string

Необязательный маркер для многофакторной проверки подлинности

Возвращаемое значение

Имя Путь Тип Описание
accessJwt
 accessJwt string

Маркер доступа JWT.
refreshJwt
 refreshJwt string

Маркер обновления JWT.
ручка
 handle string

Дескриптор пользователя.
делать
 did string

Децентрализованный идентификатор (DID) пользователя.
didDoc
 didDoc object

Необязательный документ DID.
электронная почта
 email string

Email адрес пользователя.
emailConfirmed
 emailConfirmed boolean

Индикатор подтверждения сообщения электронной почты.
emailAuthFactor
 emailAuthFactor boolean

Индикатор использования электронной почты для проверки подлинности.
активный
 active boolean

Указывает, активен ли сеанс.
статус
 status string

Состояние учетной записи пользователя.

Создание учетной записи

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

Создайте учетную запись с указанными сведениями.

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
 email string

Адрес электронной почты для учетной записи.
ручка
 handle True string

Запрошенный дескриптор для учетной записи.
делать
 did string

Предварительно существующий atproto DID, импортируемый в новую учетную запись.
inviteCode
 inviteCode string

Пригласить код для создания учетной записи.
код проверки
 verificationCode string

Код проверки электронной почты или телефона.
authenticationPhone
 verificationPhone string

Номер телефона для проверки учетной записи.
пароль
 password string

Пароль начальной учетной записи. Возможно, потребуется выполнить требования к надежности паролей для конкретного экземпляра.
recoveryKey
 recoveryKey string

Ключ поворота DID PLC (ключ восстановления) должен быть включен в операцию создания PLC.
plcOp
 plcOp object

Необязательные данные операции PLC.

Возвращаемое значение

Имя Путь Тип Описание
accessJwt
 accessJwt string

Доступ к маркеру JWT для проверки подлинности.
refreshJwt
 refreshJwt string

Обновите токен JWT для продления сеанса.
ручка
 handle string

Дескриптор новой учетной записи.
делать
 did string

DID новой учетной записи.
didDoc
 didDoc object

Документ DID, связанный с новой учетной записью.

Создание шаблона для повторного использования связи

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

Действие администратора для создания нового повторного использования шаблона.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string

Имя шаблона.
contentMarkdown
 contentMarkdown True string

Содержимое шаблона, поддерживаемого markdown, может содержать заполнители переменных.
субъект
 subject True string

Тема сообщения, используемого в сообщениях электронной почты.
lang
 lang string

Язык сообщений.
создано кем
 createdBy string

DID пользователя, создающего шаблон.

Возвращаемое значение

Тело
templateView

Список бесед

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

Вывод списка бесед.

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение разбиения на страницы
 limit integer

Максимальное количество возвращаемых бесед (по умолчанию: 50, максимум: 100).
Курсор разбиения на страницы
 cursor string

Курсор разбиения на страницы для получения следующего набора результатов.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор для разбиения на страницы.
convos
 convos array of object
id
 convos.id string

Уникальный идентификатор беседы.
оборот
 convos.rev string

Идентификатор редакции беседы.
члены
 convos.members array of chatProfileViewBasic

Список участников беседы.
lastMessage
 convos.lastMessage lastMessage

Представляет последнее сообщение в беседе.
приглушенный
 convos.muted boolean

Указывает, отключена ли беседа.
открытый
 convos.opened boolean

Указывает, был ли открыт диалог.
unreadCount
 convos.unreadCount integer

Количество непрочитанных сообщений в беседе.

Список отсутствующих BLOB-объектов для запрашивающей учетной записи

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

Возвращает список отсутствующих BLOB-объектов для запрашивающей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Ограничение результатов
 limit integer

Максимальное количество возвращаемых результатов.
Курсор разбиения на страницы
 cursor string

Курсор для результатов разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
курсор
 cursor string

Курсор разбиения на страницы для следующей страницы результатов.
большие двоичные объекты
 blobs array of listMissingBlobs.recordBlob

Список субъектов unmute

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

Отменяет указанный список учетных записей.

Параметры

Имя Ключ Обязательно Тип Описание
URI списка
 list True string

Универсальный код ресурса (URI) списка для отмены.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

Список субъектов выключения

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

Создает связь отключения для указанного списка учетных записей.

Параметры

Имя Ключ Обязательно Тип Описание
URI списка
 list True string

Ссылка на универсальный код ресурса (URI) в список учетных записей, которые необходимо отключить.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

Уведомление об обновлении

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

Уведомите службу обхода данных о недавнем обновлении и о том, что обход должен возобновиться.

Параметры

Имя Ключ Обязательно Тип Описание
hostname
 hostname True string

Имя узла текущей службы, уведомляющее об обновлении.

Уведомлять сервер о том, что запрашивающая учетная запись видела уведомления

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

Уведомите сервер о том, что запрашивающая учетная запись видела уведомления.

Параметры

Имя Ключ Обязательно Тип Описание
seenAt
 seenAt True date-time

Метка времени, указывающая, когда были замечены уведомления.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, выполнена ли операция успешно.

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

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

Удалите запись репозитория или убедитесь, что она не существует.

Параметры

Имя Ключ Обязательно Тип Описание
репозиторий
 repo True string

Дескриптор репозитория (ака, текущая учетная запись).
коллекция
 collection True string

NSID коллекции записей.
rkey
 rkey True string

Ключ записи.
swapRecord
 swapRecord string

Сравнение и переключение с предыдущей записью по CID.
swapCommit
 swapCommit string

Сравнение и переключение с предыдущей фиксацией с помощью CID.

Возвращаемое значение

Имя Путь Тип Описание
фиксация
 commit commitMeta

Удаление значений из набора

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

Удаление значений из определенного набора.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string

Имя набора для удаления значений из.
values
 values True array of string

Удаление набора

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

Удаление всего набора.

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name True string

Имя набора для удаления

Удаление сеанса

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

Удалите текущий сеанс.

Удаление сообщения для самостоятельного выполнения

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

Удалите сообщение для пользователя, отправившего его.

Параметры

Имя Ключ Обязательно Тип Описание
convoId
 convoId True string

Идентификатор беседы, содержащей сообщение, которое нужно удалить.
идентификатор сообщения
 messageId True string

Идентификатор сообщения, которое нужно удалить.

Возвращаемое значение

Тело
deletedMessageView

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

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

Удалите члена из группы озона.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string

DID члена.

Удаление учетной записи

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

Удаление учетной записи пользователя от имени администратора.

Параметры

Имя Ключ Обязательно Тип Описание
Децентрализованный идентификатор (DID)
 did True string

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, успешно ли удалена учетная запись.
сообщение
 message string

Необязательное сообщение, подробное описание результата.

Удаление учетной записи

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

Удалите учетную запись субъекта с маркером и паролем.

Параметры

Имя Ключ Обязательно Тип Описание
делать
 did True string

Децентрализованный идентификатор (DID) учетной записи для удаления.
пароль
 password True string

Пароль учетной записи.
token
 token True string

Маркер, связанный с учетной записью.

Возвращаемое значение

Имя Путь Тип Описание
успешно
 success boolean

Указывает, успешно ли выполнено удаление учетной записи.
сообщение
 message string

Необязательное сообщение об успешном выполнении.

Удаление учетной записи

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

Удаление учетной записи.

Удаление учетной записи запроса

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

Инициируйте удаление учетной записи пользователя по электронной почте.

Удаление шаблона связи

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

Удалите шаблон связи по уникальному идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
id
 id True string

Уникальный идентификатор шаблона, который необходимо удалить.

Экспорт данных учетной записи

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

Экспорт данных учетной записи.

Возвращаемое значение

response
file

Определения

preferences

Имя Путь Тип Описание
adultContentPref
 adultContentPref adultContentPref
contentLabelPref
 contentLabelPref contentLabelPref
savedFeedsPref
 savedFeedsPref savedFeedsPref
savedFeedsPrefV2
 savedFeedsPrefV2 savedFeedsPrefV2
personalDetailsPref
 personalDetailsPref personalDetailsPref
feedViewPref
 feedViewPref feedViewPref
threadViewPref
 threadViewPref threadViewPref
interestsPref
 interestsPref interestsPref
mutedWordsPref
 mutedWordsPref mutedWordsPref
hiddenPostsPref
 hiddenPostsPref hiddenPostsPref
bskyAppStatePref
 bskyAppStatePref bskyAppStatePref

Захватить сумку состояния, относящееся к программе bsky.app.
labelersPref
 labelersPref labelersPref

adultContentPref

Имя Путь Тип Описание
enabled
 enabled boolean

contentLabelPref

Имя Путь Тип Описание
labelerDid
 labelerDid string

К какой метки применяется этот параметр?
label
 label string
видимость
 visibility string

сохраненныйfeed

Имя Путь Тип Описание
id
 id string
type
 type string
value
 value string
pinned
 pinned boolean

savedFeedsPrefV2

Имя Путь Тип Описание
items
 items array of savedFeed

savedFeedsPref

Имя Путь Тип Описание
pinned
 pinned array of string
Сохранено
 saved array of string
временная шкалаIndex
 timelineIndex integer

personalDetailsPref

Имя Путь Тип Описание
birthDate
 birthDate date-time

Дата рождения владельца учетной записи.

feedViewPref

Имя Путь Тип Описание
корм
 feed string

Универсальный код ресурса (URI) веб-канала или идентификатор, описывающий веб-канал.
hideReplies
 hideReplies boolean

Скрытие ответов в канале.
hideRepliesByUnfollowed
 hideRepliesByUnfollowed boolean

Скрытие ответов в веб-канале, если они не следуют пользователям.
hideRepliesByLikeCount
 hideRepliesByLikeCount integer
hideReposts
 hideReposts boolean

Скрытие репостов в веб-канале.
hideQuotePosts
 hideQuotePosts boolean

Скрытие записей кавычек в веб-канале.

threadViewPref

Имя Путь Тип Описание
sort
 sort string

Режим сортировки потоков.
prioritizeFollowedUsers
 prioritizeFollowedUsers boolean

Показывать пользователей в верхней части всех ответов.

interestsPref

Имя Путь Тип Описание
tags
 tags array of string

mutedWordTarget

string

mutedWord

Слово, которое владелец учетной записи отключил.

Имя Путь Тип Описание
id
 id string
value
 value string

Приглушенное слово.
targets
 targets array of mutedWordTarget
actorTarget
 actorTarget string

Группы пользователей для применения отключаемого слова. Если не определено, применяется ко всем пользователям.
истекает срок действия
 expiresAt date-time

Дата и время истечения срока действия отключенного слова и больше не будет применено.

mutedWordsPref

Имя Путь Тип Описание
items
 items array of mutedWord

hiddenPostsPref

Имя Путь Тип Описание
items
 items array of string

labelersPref

Имя Путь Тип Описание
метки
 labelers array of labelerPrefItem

labelerPrefItem

Имя Путь Тип Описание
делать
 did string

starterPackView

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
запись
 record
создатель
 creator appProfileViewBasic
list
 list listViewBasic
listItemsSample
 listItemsSample array of listItemView
Каналы
 feeds array of generatorView
joinedWeekCount
 joinedWeekCount integer
joinedAllTimeCount
 joinedAllTimeCount integer
labels
 labels array of label
indexedAt
 indexedAt date-time

starterPackViewBasic

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
запись
 record
создатель
 creator appProfileViewBasic
listItemCount
 listItemCount integer
joinedWeekCount
 joinedWeekCount integer
joinedAllTimeCount
 joinedAllTimeCount integer
labels
 labels array of label
indexedAt
 indexedAt date-time

bskyAppStatePref

Захватить сумку состояния, относящееся к программе bsky.app.

Имя Путь Тип Описание
activeProgressGuide
 activeProgressGuide bskyAppProgressGuide

Если задано, активное руководство по ходу выполнения.
queuedNudges
 queuedNudges array of string
nuxs
 nuxs array of nux

bskyAppProgressGuide

Если задано, активное руководство по ходу выполнения.

Имя Путь Тип Описание
гид
 guide string

nux

Новый объект хранилища NUX

Имя Путь Тип Описание
id
 id string
завершено
 completed boolean
данные
 data string

Произвольные данные для NUX. Ограничение в 300 символов.
истекает срок действия
 expiresAt date-time

Дата и время истечения срока действия NUX.

profileViewDetailed

Имя Путь Тип Описание
делать
 did string
ручка
 handle string
отображаемое имя
 displayName string
описание
 description string
аватар
 avatar string
знамя
 banner string
followersCount
 followersCount integer
followsCount
 followsCount integer
postCount
 postsCount integer
связанный
 associated profileAssociated
joinedViaStarterPack
 joinedViaStarterPack starterPackViewBasic
indexedAt
 indexedAt date-time
созданоВ
 createdAt date-time
зритель
 viewer appViewerState

Метаданные о связи запрашивающей учетной записи с учетной записью субъекта.
labels
 labels array of label
pinnedPost
 pinnedPost strongRef

Определяет надежную ссылку с помощью URI и CID.

profileView

Основные сведения о профиле.

Имя Путь Тип Описание
делать
 did string

Децентрализованный идентификатор (DID) профиля.
ручка
 handle string

Дескриптор профиля.
отображаемое имя
 displayName string

Отображаемое имя профиля.
аватар
 avatar string

URL-адрес аватара профиля.
связанный
 associated associatedMetadata

Связанные метаданные для профиля.
зритель
 viewer viewerMetadata

Метаданные о связи средства просмотра с субъектом.
labels
 labels array of label

Метки, связанные с профилем.
созданоВ
 createdAt date-time

Метка времени создания профиля.

associatedMetadata

Связанные метаданные для профиля.

Имя Путь Тип Описание
Списках
 lists integer

Количество связанных списков.
feedgens
 feedgens integer

Число генераторов связанных веб-каналов.
starterPacks
 starterPacks integer

Количество начальных пакетов.
метка
 labeler boolean

Указывает, является ли профиль меткой.
allowIncoming
 chat.allowIncoming string

Разрешены параметры входящего чата (например, "все").

mutedByList

Сведения о списке, который отключил субъект.

Имя Путь Тип Описание
УРИ
 uri string

Универсальный код ресурса (URI) списка, который отключил субъект.
cid
 cid string

Идентификатор содержимого (CID) списка.
имя
 name string

Имя списка.
purpose
 purpose string

Назначение списка.
аватар
 avatar string

URI изображения аватара для списка.
listItemCount
 listItemCount integer

Количество элементов в списке.
labels
 labels array of label

Метки, связанные со списком.
зритель
 viewer viewerMetadata

Метаданные о связи средства просмотра с субъектом.
indexedAt
 indexedAt date-time

Метка времени индексирования списка.

blockingByList

Сведения о списке, блокирующая субъект.

Имя Путь Тип Описание
УРИ
 uri string

Универсальный код ресурса (URI) списка, блокирующая субъект.
cid
 cid string

Идентификатор содержимого (CID) списка.
имя
 name string

Имя списка.
purpose
 purpose string

Назначение списка.
аватар
 avatar string

URI изображения аватара для списка.
listItemCount
 listItemCount integer

Количество элементов в списке.
labels
 labels array of label

Метки, связанные со списком.
зритель
 viewer viewerMetadata

Метаданные о связи средства просмотра с субъектом.
indexedAt
 indexedAt date-time

Метка времени индексирования списка.

viewerMetadata

Метаданные о связи средства просмотра с субъектом.

Имя Путь Тип Описание
приглушенный
 muted boolean

Указывает, отключен ли субъект средством просмотра.
заблокировано
 blockedBy boolean

Указывает, заблокирован ли субъект средством просмотра.
блокировка
 blocking string

Указывает, блокирует ли средство просмотра субъект.
следующий
 following string

Указывает, следует ли средству просмотра следовать субъекту.
отслеживаемая
 followedBy string

Указывает, следует ли субъекту следить за средством просмотра.
mutedByList
 mutedByList mutedByList

Сведения о списке, который отключил субъект.
blockingByList
 blockingByList blockingByList

Сведения о списке, блокирующая субъект.

postView

Имя Путь Тип Описание
object

feedReplyRef

Имя Путь Тип Описание
root
 root object

Ссылка на корневую запись, которая может быть postView, notFoundPost или заблокирована.
parent
 parent object

Ссылка на родительскую запись, которая может быть postView, notFoundPost или заблокирована.
бабушка и дедушкаAuthor
 grandparentAuthor appProfileViewBasic

strongRef

Определяет надежную ссылку с помощью URI и CID.

Имя Путь Тип Описание
УРИ
 uri string

Универсальный код ресурса (URI) строгой ссылки.
cid
 cid string

CID строгой ссылки.

profileAssociated

Имя Путь Тип Описание
Списках
 lists integer
feedgens
 feedgens integer
starterPacks
 starterPacks integer
метка
 labeler boolean
чат
 chat profileAssociatedChat

appViewerState

Метаданные о связи запрашивающей учетной записи с учетной записью субъекта.

Имя Путь Тип Описание
приглушенный
 muted boolean
mutedByList
 mutedByList listViewBasic
заблокировано
 blockedBy boolean
блокировка
 blocking string
blockingByList
 blockingByList listViewBasic
следующий
 following string
отслеживаемая
 followedBy string
известныеFollowers
 knownFollowers knownFollowers

Последователи субъекта, которые вы также следуете.

profileAssociatedChat

Имя Путь Тип Описание
allowIncoming
 allowIncoming string

listView

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
создатель
 creator profileView

Основные сведения о профиле.
имя
 name string
purpose
 purpose listPurpose

Определяет назначение списка.
описание
 description string
descriptionFacets
 descriptionFacets array of richtextFacet
аватар
 avatar string
listItemCount
 listItemCount integer
labels
 labels array of label
зритель
 viewer listViewerState
indexedAt
 indexedAt date-time

listItemView

Имя Путь Тип Описание
УРИ
 uri string
субъект
 subject profileView

Основные сведения о профиле.

listViewBasic

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
имя
 name string
purpose
 purpose listPurpose

Определяет назначение списка.
аватар
 avatar string
listItemCount
 listItemCount integer
labels
 labels array of label
зритель
 viewer listViewerState
indexedAt
 indexedAt string

label

Тег метаданных для ресурса atproto (например, репозитория или записи).

Имя Путь Тип Описание
ver
 ver integer
src
 src string

DID субъекта, создавшего эту метку.
УРИ
 uri string

URI AT записи, репозитория (учетной записи) или другого ресурса, к которому применяется эта метка.
cid
 cid string

При необходимости идентификатор CID, указывающий определенную версию ресурса URI, к этой метки применяется.
Валь
 val string

Короткое строковое имя значения или типа этой метки.
отрицательный
 neg boolean

Если значение true, это метка отрицания, перезаписающая предыдущую метку.
cts
 cts date-time

Метка времени создания этой метки.
эксп
 exp date-time

Метка времени, в которой истекает срок действия этой метки (больше не применяется).
sig
 sig byte

Подпись метки в кодировке dag-cbor.

ActorMetadata

Имя Путь Тип Описание
messagesSent
 messagesSent integer

Количество сообщений, отправленных субъектом.
messagesReceived
 messagesReceived integer

Количество сообщений, полученных субъектом.
convos
 convos integer

Общее количество бесед, в которых участвовал субъект.
convosStarted
 convosStarted integer

Количество бесед, запущенных субъектом.

известныеFollowers

Последователи субъекта, которые вы также следуете.

Имя Путь Тип Описание
count
 count integer
Последователей
 followers array of appProfileViewBasic

appProfileViewBasic

Имя Путь Тип Описание
делать
 did string

Децентрализованный идентификатор (DID) субъекта.
ручка
 handle string

Уникальный дескриптор субъекта.
отображаемое имя
 displayName string

Отображаемое имя субъекта.
аватар
 avatar string

URI изображения аватара субъекта.
созданоВ
 createdAt date-time

Метка времени создания профиля субъекта.

chatProfileViewBasic

Имя Путь Тип Описание
делать
 did string
ручка
 handle string

Дескриптор субъекта.
отображаемое имя
 displayName string

Отображаемое имя субъекта.
аватар
 avatar string

URI аватара субъекта.
связанный
 associated profileAssociated
зритель
 viewer appViewerState

Метаданные о связи запрашивающей учетной записи с учетной записью субъекта.
labels
 labels array of label

Массив меток, связанных с субъектом.
chatDisabled
 chatDisabled boolean

Указывает, не может ли субъект активно участвовать в беседах.

listPurpose

Определяет назначение списка.

Имя Путь Тип Описание
type
 type string

Тип назначения списка.
Свойство Modlist
 modlistProperty string

Свойство, относяемое к модалисту.
Свойство curatelist
 curatelistProperty string

Свойство, определенное для curatelist.
Свойство ссылочного списка
 referencelistProperty string

Свойство, относяемое к списку ссылок.

listViewerState

Имя Путь Тип Описание
приглушенный
 muted boolean
блокированный
 blocked string

convoView

Представляет представление беседы.

Имя Путь Тип Описание
ID разговора
 id string

Уникальный идентификатор беседы.
Редакция беседы
 rev string

Идентификатор редакции беседы.
Участники беседы
 members array of chatProfileViewBasic

Список участников беседы.
id
 lastMessage.id string

Уникальный идентификатор сообщения.
содержимое
 lastMessage.content string

Содержимое последнего сообщения.
отметка времени
 lastMessage.timestamp date-time

Время отправки последнего сообщения.
Отключена беседа
 muted boolean

Указывает, отключена ли беседа.
Открытие беседы
 opened boolean

Указывает, был ли открыт диалог.
Число непрочитанных сообщений
 unreadCount integer

Количество непрочитанных сообщений в беседе.

messageViewSender

Имя Путь Тип Описание
делать
 did string

Децентрализованный идентификатор отправителя.

richtextFacet

Заметка подстроки в формате форматированного текста.

Имя Путь Тип Описание
index
 index richTextFacetByteSlice

Задает диапазон подстроковых аспектов, к которым применяется функция.
features
 features array of object
featureType
 features.featureType string

Тип функции.
details
 features.details object

Сведения о функции.

richTextFacetByteSlice

Задает диапазон подстроковых аспектов, к которым применяется функция.

Имя Путь Тип Описание
byteStart
 byteStart integer

Начальный байт диапазона.
byteEnd
 byteEnd integer

Конечный байт диапазона.

deletedMessageView

Имя Путь Тип Описание
id
 id string

Идентификатор удаленного сообщения.
оборот
 rev string

Идентификатор редакции удаленного сообщения.
sender
 sender messageViewSender
sentAt
 sentAt date-time

Метка времени отправки сообщения.

lastMessage

Представляет последнее сообщение в беседе.

Имя Путь Тип Описание
id
 id string

Уникальный идентификатор сообщения.
текст
 text string

Текстовое содержимое сообщения.
sender
 sender string

Идентификатор отправителя сообщения.
sentAt
 sentAt date-time

Время отправки сообщения.

accountView

Имя Путь Тип Описание
делать
 did string
ручка
 handle string
электронная почта
 email string
связанныеrecords
 relatedRecords array of
indexedAt
 indexedAt date-time
invitedBy
 invitedBy inviteCode
Приглашает
 invites array of inviteCode
invitesDisabled
 invitesDisabled boolean
emailConfirmedAt
 emailConfirmedAt date-time
inviteNote
 inviteNote string
деактивировано
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

inviteCode

Имя Путь Тип Описание
код
 code string
доступен
 available integer
disabled
 disabled boolean
forAccount
 forAccount string
создано кем
 createdBy string
созданоВ
 createdAt date-time
Использует
 uses array of inviteCodeUse

threatSignature

Имя Путь Тип Описание
property
 property string
value
 value string

inviteCodeUse

Имя Путь Тип Описание
usedBy
 usedBy string
usedAt
 usedAt date-time

statusAttr

Имя Путь Тип Описание
прикладной
 applied boolean
ref
 ref string

createAppPassword

Имя Путь Тип Описание
имя
 name string
пароль
 password string
созданоВ
 createdAt date-time
привилегированный
 privileged boolean

listAppPassword

Имя Путь Тип Описание
имя
 name string
созданоВ
 createdAt string
привилегированный
 privileged boolean
Имя Путь Тип Описание
политика конфиденциальности
 privacyPolicy string
условия обслуживания
 termsOfService string

serviceConfig

Имя Путь Тип Описание
URL-адрес
 url string

viewerConfig

Имя Путь Тип Описание
роль
 role string

описаниеServerContact

Имя Путь Тип Описание
электронная почта
 email string

описаниеFeedGeneratorFeedFeed

Имя Путь Тип Описание
УРИ
 uri string
Имя Путь Тип Описание
политика конфиденциальности
 privacyPolicy string
условия обслуживания
 termsOfService string

feedViewPost

Имя Путь Тип Описание
Поместить
 post postView
ответ
 reply feedReplyRef
type
 reason.type string
details
 reason.details object

Дополнительные сведения, относящиеся к типу причины. Соответствует либо причинеRepost, либо reasonPin.
feedContext
 feedContext string

Контекст, предоставляемый генератором веб-каналов, который может передаваться обратно вместе с взаимодействиями.

generatorView

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
делать
 did string
создатель
 creator profileView

Основные сведения о профиле.
отображаемое имя
 displayName string
описание
 description string
descriptionFacets
 descriptionFacets array of richtextFacet
аватар
 avatar string
likeCount
 likeCount integer
acceptsInteractions
 acceptsInteractions boolean
labels
 labels array of label
зритель
 viewer generatorViewerState
indexedAt
 indexedAt date-time

generatorViewerState

Имя Путь Тип Описание
как
 like string

ThreadgateView

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
запись
 record
Списках
 lists array of listViewBasic

getLikesLike

Имя Путь Тип Описание
indexedAt
 indexedAt date-time
созданоВ
 createdAt date-time
actor
 actor profileView

Основные сведения о профиле.

skeletonFeedPost

Имя Путь Тип Описание
Поместить
 post string

AT-URI должности.
reasonRepost
 reasonRepost skeletonReasonRepost
reasonPin
 reasonPin skeletonReasonPin
feedContext
 feedContext string

Контекст передается клиенту и возвращается генератору веб-каналов вместе с взаимодействиями.

skeletonReasonRepost

Имя Путь Тип Описание
перепост
 repost string

skeletonReasonPin

reasonType

Тип причины для отчета модерации. Одна из предопределенных причин.

Имя Путь Тип Описание
reasonSpam
 reasonSpam reasonSpam

Спам: частое нежелательное продвижение, ответы, упоминания
reasonViolation
 reasonViolation reasonViolation

Прямое нарушение правил сервера, законов, условий обслуживания
reasonMisleading
 reasonMisleading reasonMisleading

Вводящая в заблуждение личность, принадлежность или содержимое
reasonSexual
 reasonSexual reasonSexual

Нежелательное или неправильное сексуальное содержимое
reasonRude
 reasonRude reasonRude

Грубое, харассирование, явное или в противном случае непристойное поведение
причинаOther
 reasonOther reasonOther

Другие: отчеты, не падающие под другую категорию отчета
reasonAppeal
 reasonAppeal reasonAppeal

Апелляция: обращение к ранее принятым мере модерации

reasonSpam

Спам: частое нежелательное продвижение, ответы, упоминания

Спам: частое нежелательное продвижение, ответы, упоминания

string

reasonViolation

Прямое нарушение правил сервера, законов, условий обслуживания

Прямое нарушение правил сервера, законов, условий обслуживания

string

reasonMisleading

Вводящая в заблуждение личность, принадлежность или содержимое

Вводящая в заблуждение личность, принадлежность или содержимое

string

reasonSexual

Нежелательное или неправильное сексуальное содержимое

Нежелательное или неправильное сексуальное содержимое

string

reasonRude

Грубое, харассирование, явное или в противном случае непристойное поведение

Грубое, харассирование, явное или в противном случае непристойное поведение

string

причинаOther

Другие: отчеты, не падающие под другую категорию отчета

Другие: отчеты, не падающие под другую категорию отчета

string

reasonAppeal

Апелляция: обращение к ранее принятым мере модерации

Апелляция: обращение к ранее принятым мере модерации

string

repoRef

Имя Путь Тип Описание
делать
 did string

repoBlobRef

Имя Путь Тип Описание
делать
 did string
cid
 cid string
recordUri
 recordUri string

уведомление

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
автор
 author profileView

Основные сведения о профиле.
причина
 reason string

Ожидаемые значения: "like", "repost", "follow", "mention", "reply", "quote" и "starterpack-joined".
reasonSubject
 reasonSubject string
запись
 record
isRead
 isRead boolean
indexedAt
 indexedAt date-time
labels
 labels array of label

labelerView

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
создатель
 creator profileView

Основные сведения о профиле.
likeCount
 likeCount integer
зритель
 viewer labelerViewerState
indexedAt
 indexedAt date-time
labels
 labels array of label

labelerViewerState

Имя Путь Тип Описание
как
 like string

jobStatus

Имя Путь Тип Описание
jobId
 jobId string
делать
 did string
государство
 state string

Состояние задания обработки видео.
прогресс
 progress integer
комок
 blob binary
ошибка
 error string
сообщение
 message string

templateView

Имя Путь Тип Описание
id
 id string
имя
 name string

Имя шаблона.
субъект
 subject string

Содержимое шаблона может содержать заполнители markdown и переменных.
contentMarkdown
 contentMarkdown string

Тема сообщения, используемого в сообщениях электронной почты.
disabled
 disabled boolean
lang
 lang string

Язык сообщений.
lastUpdatedBy
 lastUpdatedBy string

DID пользователя, который последний раз обновил шаблон.
созданоВ
 createdAt date-time
обновлено
 updatedAt date-time

repoView

Имя Путь Тип Описание
делать
 did string
ручка
 handle string
электронная почта
 email string
связанныеrecords
 relatedRecords array of
indexedAt
 indexedAt date-time
moderation
 moderation moderation
invitedBy
 invitedBy inviteCode
invitesDisabled
 invitesDisabled boolean
inviteNote
 inviteNote string
деактивировано
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

moderation

Имя Путь Тип Описание
subjectStatus
 subjectStatus subjectStatusView

subjectStatusView

Имя Путь Тип Описание
id
 id integer

Уникальный идентификатор состояния субъекта.
type
 subject.type string

Тип ссылки на тему.
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

Определяет надежную ссылку с помощью URI и CID.
type
 hosting.type string

Тип размещения.
статус
 hosting.accountHosting.status string
обновлено
 hosting.accountHosting.updatedAt date-time
созданоВ
 hosting.accountHosting.createdAt date-time
статус
 hosting.recordHosting.status string
обновлено
 hosting.recordHosting.updatedAt date-time
созданоВ
 hosting.recordHosting.createdAt date-time
созданоВ
 createdAt date-time

Метка времени создания состояния субъекта.
обновлено
 updatedAt date-time

Метка времени последнего обновления состояния субъекта.
reviewState
 reviewState string

Состояние проверки субъекта.

modEventView

Имя Путь Тип Описание
id
 id integer
type
 event.type string
type
 subject.type string
subjectBlobCids
 subjectBlobCids array of string
создано кем
 createdBy string
созданоВ
 createdAt date-time
creatorHandle
 creatorHandle string
subjectHandle
 subjectHandle string

applyWrites.result

Имя Путь Тип Описание
type
 type string

Тип результата операции записи.
createResult
 createResult applyWrites.createResult
updateResult
 updateResult applyWrites.updateResult
Результат операции удаления
 deleteResult applyWrites.deleteResult

applyWrites.createResult

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
validationStatus
 validationStatus string

applyWrites.updateResult

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
validationStatus
 validationStatus string

applyWrites.deleteResult

Имя Путь Тип Описание
id
 id string

Идентификатор удаленной сущности.
deletedAt
 deletedAt date-time

Метка времени удаления сущности.

commitMeta

Имя Путь Тип Описание
cid
 cid string
оборот
 rev string

modEventViewDetail

Имя Путь Тип Описание
id
 id integer

Уникальный идентификатор события модерации.
type
 event.type string

Тип события.
type
 subject.type string

Тип темы.
SubjectBlobs
 subjectBlobs array of blobView

Сведения о больших двоичных объектах, связанных с темой.
создано кем
 createdBy string

DID пользователя, создавшего событие.
созданоВ
 createdAt date-time

Метка времени создания события.

BLOBView

Имя Путь Тип Описание
cid
 cid string

Идентификатор содержимого большого двоичного объекта.
тип MIME
 mimeType string

Тип MIME большого двоичного объекта.
size
 size integer

Размер большого двоичного объекта в байтах.
созданоВ
 createdAt date-time

Метка времени создания большого двоичного объекта.
type
 details.type string

Тип сведений о большом двоичном объекте.
imageПодробнее
 details.imageDetails imageDetails
videoDetails
 details.videoDetails videoDetails
moderation
 moderation moderation

imageПодробнее

Имя Путь Тип Описание
Ширина
 width integer

Ширина изображения в пикселях.
height
 height integer

Высота изображения в пикселях.

videoDetails

Имя Путь Тип Описание
Ширина
 width integer

Ширина видео в пикселях.
height
 height integer

Высота видео в пикселях.
length
 length integer

Длина видео в секундах.

recordViewDetail

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
value
 value
большие двоичные объекты
 blobs array of blobView
labels
 labels array of label
indexedAt
 indexedAt date-time
moderation
 moderation moderationDetail
репозиторий
 repo repoView

модерацияDetail

Имя Путь Тип Описание
subjectStatus
 subjectStatus subjectStatusView

repoViewDetail

Имя Путь Тип Описание
делать
 did string
ручка
 handle string
электронная почта
 email string
связанныеrecords
 relatedRecords array of
indexedAt
 indexedAt date-time
moderation
 moderation moderationDetail
labels
 labels array of label
invitedBy
 invitedBy inviteCode
Приглашает
 invites array of inviteCode
invitesDisabled
 invitesDisabled boolean
inviteNote
 inviteNote string
emailConfirmedAt
 emailConfirmedAt date-time
деактивировано
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

участники

Имя Путь Тип Описание
делать
 did string
disabled
 disabled boolean
profile
 profile profileViewDetailed
созданоВ
 createdAt date-time
обновлено
 updatedAt date-time
lastUpdatedBy
 lastUpdatedBy string
роль
 role string

listMissingBlobs.recordBlob

Имя Путь Тип Описание
cid
 cid string
recordUri
 recordUri string

listRecords.record

Имя Путь Тип Описание
УРИ
 uri string
cid
 cid string
value
 value

listRepos.repo

Имя Путь Тип Описание
делать
 did string
голова
 head string

Текущий CID фиксации репозитория
оборот
 rev string
активный
 active boolean
статус
 status string

Значение true или false, указывающее, почему учетная запись неактивна.

setView

Имя Путь Тип Описание
имя
 name string
описание
 description string
setSize
 setSize integer
созданоВ
 createdAt date-time
обновлено
 updatedAt date-time

sigDetail

Имя Путь Тип Описание
property
 property string
value
 value string

findRelatedAccounts.relatedAccount

Имя Путь Тип Описание
account
 account accountView
Сходства
 similarities array of sigDetail

бинарный

Это базовый тип данных binary.

file

Это базовый тип данных file.