Перейти к содержанию

cpa

Источник API: CPAАвито.json, CallTracking[КТ].json.

Пакет cpa.

CallTrackingCall dataclass

CallTrackingCall(
    transport: Transport,
    call_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

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

get

get(
    *, call_id: int | None = None
) -> CallTrackingCallResponse

Выполняет публичную операцию CallTrackingCall.get и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list

list(
    *,
    date_time_from: str,
    date_time_to: str,
    limit: int | None = None,
    offset: int | None = None,
) -> CallTrackingCallsResult

Выполняет публичную операцию CallTrackingCall.list и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

download

download(
    *, call_id: int | str | None = None
) -> CallTrackingRecord

Выполняет публичную операцию CallTrackingCall.download и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CpaArchive dataclass

CpaArchive(
    transport: Transport,
    call_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект архивных операций CPA.

get_call

get_call(
    *, call_id: int | str | None = None
) -> CpaAudioRecord

Получает архивную запись звонка.

    Deprecated: используйте `call_tracking_call().download`; удаление в версии 1.3.0.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_balance_info

get_balance_info() -> CpaBalanceInfo

Получает архивный баланс CPA.

    Deprecated: используйте `cpa_lead().get_balance_info`; удаление в версии 1.3.0.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_call_by_id

get_call_by_id(*, call_id: int) -> CpaCallInfo

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

    Deprecated: используйте `call_tracking_call().get`; удаление в версии 1.3.0.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CpaCall dataclass

CpaCall(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект CPA-звонка.

list

list(
    *, date_time_from: str, date_time_to: str
) -> CpaCallsResult

Выполняет публичную операцию CpaCall.list и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_complaint

create_complaint(
    *, call_id: int, reason: str
) -> CpaActionResult

Выполняет публичную операцию CpaCall.create_complaint и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CpaChat dataclass

CpaChat(
    transport: Transport,
    action_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

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

get

get(*, action_id: int | str | None = None) -> CpaChatInfo

Выполняет публичную операцию CpaChat.get и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list

list(
    *,
    created_at_from: str,
    limit: int | None = None,
    version: int = 2,
) -> CpaChatsResult

Выполняет публичную операцию CpaChat.list и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_phones_info_from_chats

get_phones_info_from_chats(
    *, action_ids: Sequence[str]
) -> CpaPhonesResult

Выполняет публичную операцию CpaChat.get_phones_info_from_chats и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CpaLead dataclass

CpaLead(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект CPA-лида и связанных lead-операций.

create_complaint_by_action_id

create_complaint_by_action_id(
    *, action_id: str, reason: str
) -> CpaActionResult

Выполняет публичную операцию CpaLead.create_complaint_by_action_id и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_balance_info

get_balance_info() -> CpaBalanceInfo

Выполняет публичную операцию CpaLead.get_balance_info и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CallTrackingCallInfo dataclass

CallTrackingCallInfo(
    call_id: str | None,
    item_id: str | None,
    buyer_phone: str | None,
    seller_phone: str | None,
    virtual_phone: str | None,
    call_time: str | None,
    talk_duration: int | None,
    waiting_duration: float | None,
)

Bases: SerializableModel

Информация о звонке CallTracking.

CallTrackingCallResponse dataclass

CallTrackingCallResponse(
    call: CallTrackingCallInfo, error: CpaErrorInfo
)

Bases: SerializableModel

Ответ CallTracking get_call_by_id с объектом звонка и ошибкой.

CallTrackingCallsRequest dataclass

CallTrackingCallsRequest(
    date_time_from: str,
    date_time_to: str,
    limit: int | None = None,
    offset: int | None = None,
)

Запрос списка звонков CallTracking.

CallTrackingCallsResult dataclass

CallTrackingCallsResult(
    items: list[CallTrackingCallInfo],
    error: CpaErrorInfo | None = None,
)

Bases: SerializableModel

Список звонков CallTracking.

CallTrackingGetCallByIdRequest dataclass

CallTrackingGetCallByIdRequest(call_id: int)

Запрос получения звонка CallTracking по идентификатору.

to_payload

to_payload() -> dict[str, int]

Сериализует запрос звонка CallTracking.

CallTrackingRecord dataclass

CallTrackingRecord(binary: BinaryResponse)

Бинарная запись звонка CallTracking.

filename property

filename: str | None

Имя файла записи звонка.

to_dict

to_dict() -> dict[str, object]

Сериализует бинарную запись без transport-объекта.

CpaActionResult dataclass

CpaActionResult(
    success: bool, error: CpaErrorInfo | None = None
)

Bases: SerializableModel

Результат mutation-операции CPA.

CpaAudioRecord dataclass

CpaAudioRecord(binary: BinaryResponse)

Бинарная запись звонка CPA.

filename property

filename: str | None

Имя файла записи звонка.

to_dict

to_dict() -> dict[str, object]

Сериализует бинарную запись без transport-объекта.

CpaBalanceInfo dataclass

CpaBalanceInfo(
    balance: int | None,
    advance: int | None = None,
    debt: int | None = None,
    error: CpaErrorInfo | None = None,
)

Bases: SerializableModel

Информация о CPA-балансе пользователя.

CpaCallByIdRequest dataclass

CpaCallByIdRequest(call_id: int)

Запрос получения CPA-звонка по идентификатору.

CpaCallComplaintRequest dataclass

CpaCallComplaintRequest(call_id: int, reason: str)

Запрос жалобы на CPA-звонок.

CpaCallInfo dataclass

CpaCallInfo(
    call_id: str | None,
    item_id: str | None,
    buyer_phone: str | None,
    seller_phone: str | None,
    virtual_phone: str | None,
    status_id: int | None,
    price: int | None,
    duration: int | None,
    waiting_duration: float | None,
    created_at: str | None,
    started_at: str | None,
    group_title: str | None,
    record_url: str | None,
    is_arbitrage_available: bool | None,
)

Bases: SerializableModel

Информация о звонке CPA.

CpaCallsByTimeRequest dataclass

CpaCallsByTimeRequest(
    date_time_from: str, date_time_to: str
)

Запрос списка CPA-звонков по времени.

CpaCallsResult dataclass

CpaCallsResult(
    items: list[CpaCallInfo],
    error: CpaErrorInfo | None = None,
)

Bases: SerializableModel

Список звонков CPA.

CpaChatInfo dataclass

CpaChatInfo(
    chat_id: str | None,
    action_id: str | None,
    item_id: str | None,
    item_title: str | None,
    buyer_user_id: str | None,
    buyer_name: str | None,
    created_at: str | None,
    updated_at: str | None,
    is_arbitrage_available: bool | None,
)

Bases: SerializableModel

Информация о CPA-чате.

CpaChatsByTimeRequest dataclass

CpaChatsByTimeRequest(
    created_at_from: str, limit: int | None = None
)

Запрос списка CPA-чатов по времени.

CpaChatsResult dataclass

CpaChatsResult(items: list[CpaChatInfo])

Bases: SerializableModel

Список чатов CPA.

CpaErrorInfo dataclass

CpaErrorInfo(code: int | None, message: str | None)

Bases: SerializableModel

Информация об ошибке CPA API.

CpaLeadComplaintRequest dataclass

CpaLeadComplaintRequest(action_id: str, reason: str)

Запрос жалобы по action id.

CpaPhoneInfo dataclass

CpaPhoneInfo(
    action_id: str | None,
    phone_number: str | None,
    created_at: str | None,
    price: int | None,
    group: str | None,
    preview_url: str | None,
)

Bases: SerializableModel

Информация по телефону, найденному в целевом чате.

CpaPhonesFromChatsRequest dataclass

CpaPhonesFromChatsRequest(action_ids: list[str])

Запрос телефонов из целевых чатов.

CpaPhonesResult dataclass

CpaPhonesResult(
    items: list[CpaPhoneInfo], total: int | None = None
)

Bases: SerializableModel

Список телефонных номеров из целевых чатов.