Save 44% with yearly billing.View Plans
textbee Logotextbee.dev
Documentation

Setting up textbee

Create a textbee account, install the Android app, connect the phone and grant permissions, then send your first SMS from the API.

Updated

To set up textbee, create an account, install the Android app on a phone with a SIM, connect the phone to your account and grant the SMS permissions. Then send a test message from the API. There is no sign-in inside the app: the phone connects with a QR code or an API key from the dashboard.

Before you start

  • An Android phone with Android 7.0 or newer.
  • A SIM with an active plan that can send SMS.
  • An internet connection on the phone (Wi-Fi or mobile data).
  • An email address for your account.

You must verify your email before you can send SMS. Until you do, send requests fail with a 400 error.

Step 1: Create your account

  1. Open the dashboard and choose to sign up.
  2. Sign up with email and password, or with Google.
  3. Open the verification email and click the link.

Step 2: Download the Android app

The app is not on the Play Store. You install the APK file directly.

  1. On the phone, open textbee.dev/download and download the APK.
  2. If Android asks, allow your browser to install unknown apps (Settings > Security > Install unknown apps).
  3. Open the APK and tap Install.

Step 3: Register your device

Registration links the app on the phone to your account. The app walks you through it:

  1. Open the app and tap Get Started.
  2. On Connect your account, tap Scan QR Code and scan the QR code from the dashboard. You can also tap Enter manually instead and paste an API key.
  3. On Set up your device, enter a device name (optional) and tap Register Device.

Registering a device has the full steps, including where the QR code is in the dashboard.

Step 4: Grant permissions

After registration the app shows Grant Permissions. Tap Grant All Permissions and accept each prompt. The app asks for:

PermissionWhy the app needs it
Send SMSSends the messages you request through the API.
Receive SMSForwards incoming messages to your account.
Phone StateDetects the SIM cards so you can choose a SIM per message.
Notifications (Android 13 and newer)Shows that textbee is running and sending in the background.

Tap Continue when Send SMS shows as granted. Sending needs the Send SMS permission. The other permissions add receiving, SIM selection and the running notification. The last screen, You're all set!, shows your Device ID.

On Android 15 and newer the SMS permission is locked for apps installed from an APK. Open App info, tap the menu (⋮), choose Allow restricted settings, then allow SMS. Step by step with screenshots.

Android can pause background apps to save battery, and a paused app holds your messages. Set battery usage for textbee to Unrestricted and keep the sticky notification on. Keep the phone online has the steps for each phone brand.

Send your first message

You need an API key for your code. Use the key you created for the phone, or create another one in the API Keys panel. API keys and authentication explains both.

This sample sends one message from your default device. Replace the number with your own phone number:

send.sh
BASE_URL="${TEXTBEE_BASE_URL:-https://api.textbee.dev/api/v1}"

curl -sS -X POST "$BASE_URL/gateway/send-sms" \
  -H "x-api-key: $TEXTBEE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recipients": ["+12015550123"], "message": "Hello from textbee"}'

A successful call returns 200 with an smsBatchId and a recipientCount. Then check the message in two places:

  • In the dashboard: open Messaging > History. The message shows with its status: pending first, then sent and, if the carrier sends a delivery report, delivered.
  • On the phone: open the Activity tab in the textbee app. The phone's own messaging app also shows the sent message.

If the message stays in pending, the phone did not get it. Check that the phone is online and that the app can run in the background. Messages not sending lists the common causes.

Frequently asked questions

Do I need to sign in inside the app?

No. The app connects with a QR code or an API key from the dashboard. It has no username or password field.

Can I use a phone without a SIM?

No. The phone sends each message through its own SIM and carrier. Without a SIM it cannot send or receive SMS.

Does the phone need to stay on?

Yes. textbee pushes each message to the phone, and the phone sends it. If the phone is off or offline, messages wait until it comes back.

Next steps