AccountPhones

AccountPhones: the phone numbers your account's owner messages and calls NoClick from, each proven theirs.

class AccountPhones

The numbers linked to your account. A linked number reaches the account: texts and calls from it go to its owner's NoClick, and the web's phone sign-in signs in to the account with it. So these are the signed-in owner's, or a key of your account's own that names the account:phones scope (a key with * doesn't hold it unless it's named too); any other caller raises noclick.PermissionDenied. Refusals carry their kind in error.details["reason"] (invalid_code, expired, already_linked, linked_elsewhere, last_way_in, ...).

Attributes
configuredbool
max_phonesint
phoneslist[LinkedPhone]
rawdict[str, Any]

The response JSON exactly as the API sent it.

getclassmethodasync

noclick.AccountPhones.get(*, client=None) -> AccountPhones

Read the numbers linked to the account.

Parameters
clientClient | None

The client to send with; defaults to the module client built from NOCLICK_API_KEY.

(default None)
Returns
AccountPhones

The linked numbers (phones), whether this NoClick sends codes to link one (configured) and how many an account may link (max_phones).

Usage
linked = noclick.AccountPhones.get()
print([p.phone for p in linked.phones])

verifyclassmethodasync

noclick.AccountPhones.verify(challenge_id, code, *, client=None) -> LinkedPhone

Link the challenge's number with the code texted to it. A wrong code raises noclick.InvalidRequest (reason invalid_code) and can be tried again; an expired challenge (noclick.Expired) or too many tries (noclick.RateLimited) needs a new code.

Parameters
challenge_idstrrequired
codestrrequired
clientClient | None

The client to send with; defaults to the module client built from NOCLICK_API_KEY.

(default None)
Returns
LinkedPhone

The number, linked: proven by a code (source verify), and when.

Usage
noclick.AccountPhones.verify(challenge.id, "123456")

LinkedPhone

class LinkedPhone

One number linked to the account: how it was proven (verify, a code texted to it; whatsapp or imessage, it texted NoClick) and when.

Attributes
phonestr
sourcestr
verified_atdatetime | None

PhoneChallenge

class PhoneChallenge

A code texted to a number to link it: check it with AccountPhones.verify before expires_at.

Attributes
idstr
phonestr
expires_atdatetime | None
rawdict[str, Any]

The response JSON exactly as the API sent it.