# TextBee API

TextBee API is a self-hosted communication app. TextBee is a self-hosted, open-source SMS gateway for developers and homelab users that uses Android phones to send and receive text messages via a web dashboard or REST API. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/3391/textbee-api

## Description

TextBee is a self-hosted, open-source SMS gateway for developers and homelab users that uses Android phones to send and receive text messages via a web dashboard or REST API.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

76/100 (Good), based on 3 of 4 factors.
- Maintained: 100 (last commit 17 days ago)
- Popular: 70 (3,274 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Official website: https://textbee.dev
- GitHub: https://github.com/textbee/textbee
- Documentation: https://textbee.dev/docs
- Unraid: https://ca.unraid.net/apps/textbee-api-1prx0d60ejukri?q=TextBee---API

## Common questions

### How do I pair an Android phone with TextBee?

Install the TextBee app, grant it SMS permissions, and open the dashboard to register the device or generate an API key. Then scan the QR code with the app or enter the API key manually.

### What header details are required to pull message history from the TextBee API?

Include your API key in the x-api-key header and use the device ID for the Android device. If either value is missing or wrong, the API will not return messages for that device.

### What must a webhook endpoint do for TextBee webhook delivery to work?

Provide a public URL that can receive POST requests and select the SMS events you want. The handler should reply with 200 OK and use the webhook secret to verify that the request came from TextBee.

### Can TextBee send to multiple recipients in one API request?

Yes, its bulk messaging supports sending to many recipients in a single API call. This is intended for campaigns, alerts, and broadcasts.

## Alternatives

- Twilio: Twilio is a web-service API that lets you use your existing web languages and skills to build voice and SMS applications.

---
Source: Our Local Host (https://ourlocalhost.com/app/3391/textbee-api), the self-hosted and open-source app directory.
