messenger¶

Публичный доменный пакет SDK: messenger.

Enum¶

Bases: DomainObject

Доменный объект чата.

get ¶

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ChatInfo

Получает чат по chat_id.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

ChatInfo с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list ¶

list(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ChatsResult

Возвращает список чатов.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

ChatsResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

mark_read ¶

mark_read(
    *,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Помечает чат как прочитанный.

Аргументы

idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

blacklist ¶

blacklist(
    *,
    blacklisted_user_id: int,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Добавляет пользователя в blacklist.

Аргументы

blacklisted_user_id: идентификатор пользователя, которого нужно добавить в черный список. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

Доменный объект media-функций мессенджера.

get_voice_files ¶

get_voice_files(
    *,
    voice_ids: Sequence[str] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> VoiceFilesResult

Получает голосовые сообщения.

Аргументы

voice_ids: идентификаторы голосовых файлов. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

VoiceFilesResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

upload_images ¶

upload_images(
    *,
    files: list[UploadImageFile],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> UploadImagesResult

Загружает изображения для сообщений.

Аргументы

files: файлы изображений для загрузки. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

UploadImagesResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

Доменный объект сообщения чата.

list ¶

list(
    *,
    chat_id: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessagesResult

Возвращает список сообщений чата.

Аргументы

chat_id: идентифицирует чат. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessagesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

send_message ¶

send_message(
    *,
    chat_id: str | None = None,
    message: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

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

Аргументы

chat_id: идентификатор чата. message: текст отправляемого сообщения. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

send_image ¶

send_image(
    *,
    chat_id: str | None = None,
    image_id: str,
    caption: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Отправляет сообщение с изображением.

Аргументы

chat_id: идентификатор чата. image_id: идентификатор изображения для отправки. caption: подпись к изображению, если поддерживается операцией. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete ¶

delete(
    *,
    chat_id: str | None = None,
    message_id: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Удаляет сообщение.

Аргументы

chat_id: идентификатор чата. message_id: идентификатор сообщения. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

Доменный объект webhook мессенджера.

list ¶

list(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> SubscriptionsResult

Возвращает список webhook-подписок чатов.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

SubscriptionsResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

unsubscribe ¶

unsubscribe(
    *,
    url: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> WebhookActionResult

Отключает webhook.

Аргументы

url: URL источника данных. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

WebhookActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

subscribe(
    *,
    url: str,
    secret: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> WebhookActionResult

Включает webhook v3.

Аргументы

url: URL источника данных. secret: секрет webhook-подписки для проверки входящих событий. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

WebhookActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

Доменный объект рассылки скидок и спецпредложений.

get_available ¶

get_available(
    *,
    item_ids: list[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> SpecialOfferAvailableResult

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

SpecialOfferAvailableResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_multi ¶

create_multi(
    *,
    item_ids: list[int],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MultiCreateSpecialOfferResult

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

Аргументы

item_ids: передает список объявлений для рассылки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MultiCreateSpecialOfferResult с идентификатором и статусом рассылки.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

confirm_multi ¶

confirm_multi(
    *,
    dispatch_id: int,
    recipients_count: int,
    offer_slug: str,
    discount_value: int | None = None,
    expires_at: int | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> WebhookActionResult

Подтверждает и оплачивает рассылку.

Аргументы

dispatch_id: идентифицирует рассылку. recipients_count: задает число получателей рассылки. offer_slug: задает выбранный вариант предложения. discount_value: задает финальный размер скидки, если он применим. expires_at: задает timestamp окончания предложения. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

WebhookActionResult со статусом подтверждения.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_stats ¶

get_stats(
    *,
    date_time_from: DateInput,
    date_time_to: DateInput,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> SpecialOfferStatsResult

Получает статистику рассылки.

Аргументы

date_time_from: задает начало периода в формате RFC3339. date_time_to: задает конец периода в формате RFC3339. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

SpecialOfferStatsResult со статистикой рассылки.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_tariff_info ¶

get_tariff_info(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> TariffInfo

Получает информацию о тарифе спецпредложений.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TariffInfo с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

Async-доменный объект чата.

get `async` ¶

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ChatInfo

Получает чат по chat_id асинхронно.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

ChatInfo с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list `async` ¶

list(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ChatsResult

Возвращает список чатов асинхронно.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

ChatsResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

mark_read `async` ¶

mark_read(
    *,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Помечает чат как прочитанный асинхронно.

Аргументы

idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

blacklist `async` ¶

blacklist(
    *,
    blacklisted_user_id: int,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Добавляет пользователя в blacklist асинхронно.

Аргументы

blacklisted_user_id: идентификатор пользователя, которого нужно добавить в черный список. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

Async-доменный объект media-функций мессенджера.

get_voice_files `async` ¶

get_voice_files(
    *,
    voice_ids: Sequence[str] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> VoiceFilesResult

Получает голосовые сообщения асинхронно.

Аргументы

voice_ids: идентификаторы голосовых файлов. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

VoiceFilesResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

upload_images `async` ¶

upload_images(
    *,
    files: list[UploadImageFile],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> UploadImagesResult

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

Аргументы

files: файлы изображений для загрузки. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

UploadImagesResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

Async-доменный объект сообщения чата.

list `async` ¶

list(
    *,
    chat_id: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessagesResult

Возвращает список сообщений чата асинхронно.

Аргументы

chat_id: идентифицирует чат. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessagesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

send_message `async` ¶

send_message(
    *,
    chat_id: str | None = None,
    message: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

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

Аргументы

chat_id: идентификатор чата. message: текст отправляемого сообщения. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

send_image `async` ¶

send_image(
    *,
    chat_id: str | None = None,
    image_id: str,
    caption: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

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

Аргументы

chat_id: идентификатор чата. image_id: идентификатор изображения для отправки. caption: подпись к изображению, если поддерживается операцией. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete `async` ¶

delete(
    *,
    chat_id: str | None = None,
    message_id: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MessageActionResult

Удаляет сообщение асинхронно.

Аргументы

chat_id: идентификатор чата. message_id: идентификатор сообщения. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MessageActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

Async-доменный объект webhook мессенджера.

list `async` ¶

list(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> SubscriptionsResult

Возвращает список webhook-подписок чатов асинхронно.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

SubscriptionsResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

unsubscribe `async` ¶

unsubscribe(
    *,
    url: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> WebhookActionResult

Отключает webhook асинхронно.

Аргументы

url: URL источника данных. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

WebhookActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

subscribe(
    *,
    url: str,
    secret: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> WebhookActionResult

Включает webhook v3 асинхронно.

Аргументы

url: URL источника данных. secret: секрет webhook-подписки для проверки входящих событий. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

WebhookActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

Async-доменный объект рассылки скидок и спецпредложений.

get_available `async` ¶

get_available(
    *,
    item_ids: list[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> SpecialOfferAvailableResult

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

SpecialOfferAvailableResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_multi `async` ¶

create_multi(
    *,
    item_ids: list[int],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> MultiCreateSpecialOfferResult

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

Аргументы

item_ids: передает список объявлений для рассылки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

MultiCreateSpecialOfferResult с идентификатором и статусом рассылки.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

confirm_multi `async` ¶

confirm_multi(
    *,
    dispatch_id: int,
    recipients_count: int,
    offer_slug: str,
    discount_value: int | None = None,
    expires_at: int | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> WebhookActionResult

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

Аргументы

dispatch_id: идентифицирует рассылку. recipients_count: задает число получателей рассылки. offer_slug: задает выбранный вариант предложения. discount_value: задает финальный размер скидки, если он применим. expires_at: задает timestamp окончания предложения. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

WebhookActionResult со статусом подтверждения.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_stats `async` ¶

get_stats(
    *,
    date_time_from: DateInput,
    date_time_to: DateInput,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> SpecialOfferStatsResult

Получает статистику рассылки асинхронно.

Аргументы

date_time_from: задает начало периода в формате RFC3339. date_time_to: задает конец периода в формате RFC3339. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

SpecialOfferStatsResult со статистикой рассылки.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_tariff_info `async` ¶

get_tariff_info(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> TariffInfo

Получает информацию о тарифе спецпредложений асинхронно.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TariffInfo с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

messenger¶

Enum¶

get ¶

list ¶

mark_read ¶

blacklist ¶

get_voice_files ¶

upload_images ¶

list ¶

send_message ¶

send_image ¶

delete ¶

list ¶

unsubscribe ¶

subscribe ¶

get_available ¶

create_multi ¶

confirm_multi ¶

get_stats ¶

get_tariff_info ¶

get async ¶

list async ¶

mark_read async ¶

blacklist async ¶

get_voice_files async ¶

upload_images async ¶

list async ¶

send_message async ¶

send_image async ¶

delete async ¶

list async ¶

unsubscribe async ¶

subscribe async ¶

get_available async ¶

create_multi async ¶

confirm_multi async ¶

get_stats async ¶

get_tariff_info async ¶

get `async` ¶

list `async` ¶

mark_read `async` ¶

blacklist `async` ¶

get_voice_files `async` ¶

upload_images `async` ¶

list `async` ¶

send_message `async` ¶

send_image `async` ¶

delete `async` ¶

list `async` ¶

unsubscribe `async` ¶

subscribe `async` ¶

get_available `async` ¶

create_multi `async` ¶

confirm_multi `async` ¶

get_stats `async` ¶

get_tariff_info `async` ¶