PhoneNumber

Numbers for sale in country (US by default) of type (local by default), narrowed by areaCode, locality (a city), region, contains (digits, letters or * wildcards), startsWith and endsWith (digits of the national number), and features (voice, or voice_sms for numbers that take texts too). Each comes with its prices and what its country asks before it's sold.

The countries numbers are for sale in, with the kinds of number sold in each. Right after a deploy, while that is still being found out, the API answers 503 with Retry-After, which the client retries on its own.

Where in country numbers of type (local by default) are for sale: cities, or area codes in North America.

Buy number; refused with PriceExceeded if it costs more than maxMonthlyUsd a month or maxUpfrontUsd once (by default, the upfrontUsd an AvailableNumber showed; 0 for a number passed as a string). A number whose country asks who holds it takes address, with a phone where a requirement's kind is contact. One whose country asks for documents takes requirements: each textual and document requirement's answer by its id (the text, or a NumberDocument from PhoneNumber.uploadDocument); it resolves to a PhoneNumberOrder in the carrier's review (days, sometimes), and nothing is charged until it completes. name is what your code calls it, unique among its user's numbers (a taken one is a Conflict with existingId, before anything is bought).

Upload a document one of a number's requirements asks for (a requirement of kind document in country's numbers of type, local by default): a PDF, PNG or JPEG up to 20 MB. requirement is the requirement or its id. The carrier holds the file; NoClick keeps only its name and what it's for. Pass the result in requirements when you buy.

The numbers (up to 1,000) in your phone provider account that connection (a Connection or its name, connected with the account's own credentials; one holding a restricted API key throws InvalidRequest naming connection) can route, each with its label, whether its calls go somewhere today and, when it's already connected to NoClick, its phoneNumberId and agentId.

Connect number, which you keep with your own phone provider, through connection (its account, connected with the account's own credentials: NoClick checks the provider's signed calls with the account's secret, which a restricted key can't). NoClick remembers where its calls go today and leaves them there until answerWith routes them to an agent; disconnect() puts them back. The provider bills the number and its minutes; NoClick bills only what it adds (the agent's time on a call). Inside asUser it's the user's number on the user's connection. A number already connected, or one another NoClick workflow answers, throws Conflict; one on a SIP trunk, InvalidRequest.

Invite-only beta. Port US local numbers in from their carrier, so they become NoClick numbers: one, or several on one account at that carrier (one letter of authorization covers them). accountHolder signs the letter on a NoClick page, branded like your other pages; the rest is how the current carrier knows the account, as its bill shows it. Each number keeps working with its carrier until it moves; then it's a NoClick number, billed monthly like a bought one (PriceExceeded, nothing sent, above maxMonthlyUsd). A number you connected through your own phone provider is disconnected first (InvalidRequest otherwise); for one kept with Twilio, the account's name is "Twilio, Inc.", its number the last 8 characters of your Account SID, and the PIN comes from Twilio's support. Resolves to a PortRequest whose wait() gives the PhoneNumbers.

A lazy reference to the number called name for the current (or given) user. With createIfMissing your code is the definition: the first time it's used with none of that name, NoClick buys a US local number in areaCode (any US one when omitted) for at most maxMonthlyUsd a month and maxUpfrontUsd once, and names it, or with connect connects that number of yours through connection instead; an existing number whose recordCalls differs is updated.

A lazy reference to a number you own, by id.

Load a number by id now; an unknown id, or one you released, raises noclick.NotFound.

The numbers you own (the current user's inside asUser, or those userFilter covers).

One page of numbers; pass nextCursor back as cursor.

Give the number back; it stops ringing and billing. A connected number throws Conflict: disconnect() it.

Hand a connected number back to its provider account: NoClick takes it off its agent, puts back where its calls went before, and it leaves your list. A bought number throws Conflict: release() it.

Rename it (name: null removes its name; one another of its user's numbers has is a Conflict), or start or stop recording its calls from the next call (both sides in one file; the caller hears that the call is recorded before the agent speaks).

Route inbound calls to agent, an agent on the sdk harness, whose tools and connections work during a call as in a message; one on a coding harness can't answer calls (NotAvailable). Calling it again replaces the whole setup: an option left out goes back to its default.

Call to with the number's answering agent working toward goal (agent, if given, must be that agent). wait() resolves to the PhoneCall with its transcript at hang-up.

The calls on this number, newest first: the calls it answered with the ones it placed. direction keeps one kind, since those that started at or after it, and limit the newest that many.

Invite-only beta. The texts its answering agent sent callers (send_text) and the texts the number received, newest first. A reply doesn't wake the agent: read it here, or take phone.text.received events. direction keeps one kind, since those at or after it.

Invite-only beta. Move the number to another carrier: what that carrier asks for (the account it's on and a transfer PIN for it). Another carrier may take the number for 30 days from now; a request outside that window, or quoting another PIN, is refused, so nobody takes it without you. Once it moves, it leaves your numbers and its billing stops.