canonical: https://jentic.com/apis/textbee.dev/textbee-dev

# TextBee SMS Gateway

Turn your Android phone into a powerful SMS gateway. Send and receive SMS messages via a simple REST API. The API exposes 2 endpoints secured with apiKey authentication.

## For AI agents

Programmatically send sms, get message history. Covers 2 operations with apiKey authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Send SMS
- Get message history
- Integrate TextBee SMS Gateway into automated workflows
- Query and filter TextBee SMS Gateway records by parameters
- Monitor TextBee SMS Gateway operational status and events

## Use cases

### Communications Operations

Use the TextBee SMS Gateway to perform communications operations programmatically. The API provides 2 endpoints covering core functionality including send sms, get message history.

Example prompt: Call POST `/gateway/devices/{deviceId}/send-sms` to send sms

### Data Retrieval and Monitoring

Query TextBee SMS Gateway resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary TextBee SMS Gateway endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call TextBee SMS Gateway endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'send sms', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/gateway/devices/{deviceId}/send-sms` | Send SMS |
| GET | `/gateway/devices/{deviceId}/messages` | Get message history |

## Key resources

- **Gateway** — Operations for gateway

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 69 / 100
- **View full report:** https://jentic.com/apis/textbee.dev/textbee-dev/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the TextBee SMS Gateway by hand means learning its x-api-key header auth against the api.textbee.dev/api/v1 host and coding each device send and message-read call yourself. Through Jentic you install once, import the TextBee SMS Gateway from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** TextBee puts the device id in the URL path (`/gateway/devices/{deviceId}/send-sms`), so a rule can pin your agent to one device: it can send and read messages for that device and nothing else. You choose the operations it may call, so sending is not included unless you add it.
- **Credential handling:** Your TextBee API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send an SMS from a device' or 'read received messages', and Jentic returns the matching TextBee SMS Gateway operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the TextBee SMS Gateway use?

The TextBee SMS Gateway uses an API key passed in the `x-api-key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I send sms with the TextBee SMS Gateway?

Yes. Use the POST `/gateway/devices/{deviceId}/send-sms` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the TextBee SMS Gateway?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I send sms through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'send sms'. Jentic returns the matching TextBee SMS Gateway operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the TextBee SMS Gateway have?

The TextBee SMS Gateway exposes 2 endpoints covering gateway operations.

### Can I limit what my agent is allowed to do with the TextBee SMS Gateway?

Yes. Jentic One runs self-hosted, so your own rules decide which TextBee operations and credentials the agent may use. Because TextBee puts the device id in the URL path, you can pin the agent to a single device and let it work only with that device's messages. You also choose the operations it may call, so you can allow it to read message history via GET `/gateway/devices/{deviceId}/messages` while leaving out POST `/gateway/devices/{deviceId}/send-sms` unless you add it.