Skip to content

@mega-yfue/eufy-sdk / PushPayload

Interface: PushPayload ​

Normalised device push payload. Superset of the common fields across device types plus the v6 enrichment; concrete pushes populate a subset. The short single-letter keys are eufy's wire names (kept for fidelity).

Extends ​

Indexable ​

ts
[k: string]: unknown

Properties ​

a? ​

ts
a?: number;

ai_detect_type? ​

ts
ai_detect_type?: string;

Comma list of detection types, e.g. "0,1,2,3" (person/vehicle/pet/package).

Inherited from ​

PushEnrichment.ai_detect_type


ai_faces? ​

ts
ai_faces?: object[];

confidence? ​

ts
confidence?: number;

face_id? ​

ts
face_id?: number;

height? ​

ts
height?: number;

width? ​

ts
width?: number;

x? ​

ts
x?: number;

y? ​

ts
y?: number;

Inherited from ​

PushEnrichment.ai_faces


alarm_type? ​

ts
alarm_type?: number;

arming? ​

ts
arming?: number;

c? ​

ts
c?: number;

channel? ​

ts
channel?: number;

cipher? ​

ts
cipher?: number;

cover_path? ​

ts
cover_path?: string;

Inherited from ​

PushEnrichment.cover_path


create_time? ​

ts
create_time?: number;

crop_local_path? ​

ts
crop_local_path?: string;

Inherited from ​

PushEnrichment.crop_local_path


crop_url? ​

ts
crop_url?: string;

Inherited from ​

PushEnrichment.crop_url


crying? ​

ts
crying?: number | boolean;

Sound/cry detection (indoor).

Inherited from ​

PushEnrichment.crying


device_name? ​

ts
device_name?: string;

device_sn? ​

ts
device_sn?: string;

duration? ​

ts
duration?: number;

Inherited from ​

PushEnrichment.duration


e? ​

ts
e?: string;

event_end_time? ​

ts
event_end_time?: number;

Inherited from ​

PushEnrichment.event_end_time


event_time? ​

ts
event_time?: number;

event_type? ​

ts
event_type?: number;

face_id? ​

ts
face_id?: number;

Inherited from ​

PushEnrichment.face_id


face_ids? ​

ts
face_ids?: number[];

Inherited from ​

PushEnrichment.face_ids


familiar_faces? ​

ts
familiar_faces?: unknown[];

Inherited from ​

PushEnrichment.familiar_faces


file_path? ​

ts
file_path?: string;

k? ​

ts
k?: number;

m? ​

ts
m?: number;

Unverified vendor field; polarity and entity scope are not established.


mode? ​

ts
mode?: number;

msg_type? ​

ts
msg_type?: number;

n? ​

ts
n?: string;

name? ​

ts
name?: string;

nick_name? ​

ts
nick_name?: string;

notification_style? ​

ts
notification_style?: number;

objects? ​

ts
objects?: 
  | string[]
  | {
  names?: string[];
};

Detected object class names.

Inherited from ​

PushEnrichment.objects


p? ​

ts
p?: string;

person? ​

ts
person?: string | number;

Inherited from ​

PushEnrichment.person


person_count? ​

ts
person_count?: number;

Inherited from ​

PushEnrichment.person_count


person_id? ​

ts
person_id?: number;

Inherited from ​

PushEnrichment.person_id


pet_type? ​

ts
pet_type?: string | number;

Inherited from ​

PushEnrichment.pet_type


pic_url? ​

ts
pic_url?: string;

push_count? ​

ts
push_count?: number;

s? ​

ts
s?: string;

session_id? ​

ts
session_id?: string;

short_user_id? ​

ts
short_user_id?: string;

short_video_url? ​

ts
short_video_url?: string;

Inherited from ​

PushEnrichment.short_video_url


sound_detection? ​

ts
sound_detection?: number | boolean;

Inherited from ​

PushEnrichment.sound_detection


sound_type? ​

ts
sound_type?: string | number;

Inherited from ​

PushEnrichment.sound_type


station_sn? ​

ts
station_sn?: string;

storage_type? ​

ts
storage_type?: number;

thumbnail? ​

ts
thumbnail?: string;

Media enrichment.

Inherited from ​

PushEnrichment.thumbnail


trigger_time? ​

ts
trigger_time?: number;

Timing.

Overrides ​

PushEnrichment.trigger_time


type? ​

ts
type?: number;

unique_id? ​

ts
unique_id?: string;

user_id? ​

ts
user_id?: string;

user_name? ​

ts
user_name?: string;

vehicle_types? ​

ts
vehicle_types?: string[];

Inherited from ​

PushEnrichment.vehicle_types


video_url? ​

ts
video_url?: string;

Inherited from ​

PushEnrichment.video_url

Independent and unofficial. Not affiliated with, endorsed by, or sponsored by Anker Innovations, Anker eufy, or eufy. "Anker eufy", "eufy" and "Anker" are trademarks of their respective owners. Use responsibly — rapid or failed logins can trigger captcha or temporary cooldowns.