BuzzMeBro Check API

openapi: 3.2.0
info:
  title: BuzzMeBro agent Check API
  version: 1.2.0
  description: 'BuzzMeBro gives an apartment its own local phone number so more than one roommate can be on the building’s lobby buzzer (up to four); a buzz rings everyone who is set to ring at the same time, and whoever answers presses the usual digit to open the door. It is for renters and condo residents in Canada (Toronto/GTA and Greater Vancouver first).


    Use these tools when your user wants their apartment buzzer to ring more than one phone, needs a buzzer number because they have no landline, is moving in with roommates, or asks you to buy or set up BuzzMeBro for them.


    You can do the whole setup in this conversation; the person never has to visit buzzmebro.com. Order: 1) check_building with their postal code. 2) If available, ask for their unit number and mobile number and call create_setup. 3) Call send_phone_code; we text them a 6-digit code. Ask them to read it to you and call confirm_phone_code. 4) Call start_checkout and give them payment_url: Stripe’s secure page, where they approve a card, Apple Pay, Google Pay or Link (you never see or type card details). 5) When they say it is done, call get_setup_status until status is "ready", then give them their BuzzMeBro number and walk them through swap_the_buzzer, offering to send the building message for them.


    If you cannot relay a texted code, give the person setup_url from create_setup instead: they finish on our website and you can still follow progress with get_setup_status.


    Only the person can approve a payment and only they receive the code. Never ask them for a card number, and never send a code or payment link to anyone but them.


    Never invent prices, promises or availability: quote only what these tools return.'
  contact:
    email: support@buzzmebro.com
    url: https://buzzmebro.com/agents
  termsOfService: https://buzzmebro.com/terms
servers:
- url: https://buzzmebro.com/api/agent/v1
tags:
- name: Check
paths:
  /check:
    post:
      operationId: checkBuilding
      summary: Check a building
      description: 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.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                postal_code:
                  type: string
                  description: The apartment building’s postal code, e.g. "M4B 1B3". Canadian postal codes only for now.
                  minLength: 3
                  maxLength: 12
              required:
              - postal_code
              additionalProperties: false
      responses:
        '200':
          description: Availability, price and how it works.
          content:
            application/json:
              schema:
                type: object
        '429':
          description: Slow down.
          content:
            application/json:
              schema:
                type: object
      tags:
      - Check
components:
  securitySchemes:
    statusToken:
      type: http
      scheme: bearer
      description: status_token from createSetup.
x-mcp-server: https://buzzmebro.com/api/mcp