Wyze API Methods
The following objects represent data from the Wyze REST APIs:
WyzeCredential
pydantic-model
Authenticated credentials; see wyzecam.api.login.
Attributes:
Name | Type | Description |
---|---|---|
access_token |
str |
Access token used to authenticate other API calls |
refresh_token |
str |
Refresh token used to refresh the access_token if it expires |
user_id |
str |
Wyze user id of the authenticated user |
mfa_options |
Optional[Dict[str, Any]] |
Additional options for 2fa support |
mfa_details |
Optional[Dict[str, Any]] |
Additional details for 2fa support |
sms_session_id |
Optional[str] |
Additional details for SMS support |
phone_id |
str |
The phone id passed to login() |
WyzeAccount
pydantic-model
User profile information; see wyzecam.api.get_user_info.
Attributes:
Name | Type | Description |
---|---|---|
phone_id |
str |
The phone id passed to login() |
logo |
str |
URL to a profile photo of the user |
nickname |
str |
nickname of the user |
email |
str |
email of the user |
user_code |
str |
code of the user |
user_center_id |
str |
center id of the user |
open_user_id |
str |
open id of the user (used for authenticating with newer firmwares; important!) |
WyzeCamera
pydantic-model
Wyze camera device information; see wyzecam.api.get_camera_list.
Attributes:
Name | Type | Description |
---|---|---|
p2p_id |
str |
the p2p id of the camera, used for identifying the camera to tutk. |
enr |
str |
the enr of the camera, used for signing challenge requests from cameras during auth. |
mac |
str |
the mac address of the camera. |
product_model |
str |
the product model (or type) of camera |
camera_info |
Optional[Dict[str, Any]] |
populated as a result of authenticating with a camera using a WyzeIOTCSession. |
nickname |
Optional[str] |
the user specified 'nickname' of the camera |
timezone_name |
Optional[str] |
the timezone of the camera |