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 rejects with PermissionDenied. Refusals carry their kind in error.details.reason (invalid_code, expired, already_linked, linked_elsewhere, last_way_in, ...).

Attributes
configuredboolean

Whether this NoClick sends codes to link a number.

maxPhonesnumber

How many numbers an account may link.

phonesreadonly LinkedPhone[]
rawJsonObject

The response JSON exactly as the API sent it.

Types
type JsonObject = { [key: string]: unknown };

getstatic

static get(options?: { client?: NoClick }): Promise<AccountPhones>

Read the numbers linked to the account.

const { phones, maxPhones } = await AccountPhones.get();
Parameters
options.clientNoClick

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

Returns

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

verifystatic

static verify(
  challengeId: string,
  code: string,
  options?: { client?: NoClick },
): Promise<LinkedPhone>

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

await AccountPhones.verify(challenge.id, "123456");
Parameters
challengeIdstringrequired
codestringrequired
options.clientNoClick

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

Returns

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

LinkedPhone

interface 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
phonestring
sourcestring
verifiedAtDate | null

PhoneChallenge

interface PhoneChallenge

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

Attributes
idstring
phonestring
expiresAtDate | null
rawJsonObject

The response JSON exactly as the API sent it.

Types
type JsonObject = { [key: string]: unknown };