BuzzMeBro

Checks whether BuzzMeBro can give this building a local buzzer number, and returns the price, the free-trial terms and how the service works. Call this first. Stores nothing and costs nothing.

Creates a BuzzMeBro setup for the person and returns setup_id and a status_token you must keep for every later call (plus setup_url, a fallback link if you cannot relay a texted code). Only call it after check_building said available and the person has asked you to set it up. No text message is sent and nothing is charged by this call. Next: send_phone_code.

Texts a 6-digit code to the mobile number given in create_setup (never to any other number). Tell the person a text is coming and ask them to read the code to you, then call confirm_phone_code. Call again only if it has not arrived after a minute; each setup gets 3 codes.

Checks the code the person read back to you. This proves the phone is theirs, which matters because that phone will open their front door. Five tries per setup. Next: start_checkout.

After confirm_phone_code: creates the person’s BuzzMeBro account and apartment and returns payment_url, Stripe’s own secure page where the person approves a card, Apple Pay, Google Pay or Link (with the free month when it applies, nothing is charged until it ends). Give them the link or message_for_the_person; you never see or type card details. Calling it again returns a fresh link for the same apartment.

Reads how far the setup has got and says what to do next. Once the person has paid, this call gets their number; when status is "ready" it returns their new BuzzMeBro number and swap_the_buzzer: the steps to get the building to point the buzzer at that number, and ready-to-send messages for building management, the landlord, the concierge, the superintendent or a building portal.

Returns how the partner program works: the 50% share of collected revenue, what counts and what does not, when and how payouts happen, the rules, and the steps to join. Call it first and explain it to the person before applying. Stores nothing.

無需輸入參數。

Starts a partner application with the person’s details and returns application_id and application_token. Only call it when the person has asked to join. No text is sent by this call. Next: partner_send_code.

Texts a 6-digit code to the mobile number in the application (never any other number). Ask the person to read it to you, then call partner_confirm_code. Each application gets 3 codes, at least a minute apart.

Checks the texted code. Five tries per application. Next: partner_terms_link.

Returns a one-time link to the partner terms. Give it to the person: they read the terms and press Accept themselves. You cannot accept for them. When they say it is done, call partner_claim_key.

After the person accepted the terms: returns their partner link, code and partner key. The key is shown once; keep it private and use it for the partner_get_* tools. The application token stops working after this call.

Returns the partner’s share link, typed code, a QR code (SVG) and their dashboard address.

Returns ready texts, a resident email, a move-in text and email to forward to new tenants, desk card and move-in insert wording with the partner’s link, links to the partner’s printable move-in package (move-in insert and QR card PDFs with their own QR and code), plus the house rules for sharing (honest words only, no pressure, never ask residents for phone numbers or door codes).

Returns status, visits, signups, free months, paying apartments, collected revenue, earnings by state (on hold, ready, paid, reversed), the share ledger (apartments as codes only, never names or addresses) and payout history. Quote only these numbers.

Returns a one-time link to a BuzzMeBro page that sends the person to Stripe’s own secure page, where THEY confirm their identity and add their bank. You never see or type bank details. Payouts start once they have at least $25 ready. First-time setup only: once payouts work, payout changes are made by the partner on their signed-in dashboard. The partner gets a text whenever this link is made.

Lists the extra tracked links (one per location, building or staff member) with each one’s visits, apartments and earnings. Every apartment and every dollar rolls up to the partner.

Adds a tracked link with its own code for one location, building or staff member (up to 50). Renters who use it count for this partner, with the same two-months-free perk.

Switches off one tracked link: its code stops bringing new apartments. Apartments it already brought stay with the partner.

Revokes the current partner key and returns a new one (shown once). Use it if the key may have leaked. The partner gets a text whenever the key is replaced.