canonical: https://jentic.com/apis/flowroute.com/flowroute

# Flowroute Telephony API

Jentic publishes the only available OpenAPI specification for Flowroute Telephony API, keeping it validated and agent-ready. Flowroute is a US-based telephony provider offering programmatic access to phone numbers, SMS and MMS messaging, and call routing. The API uses JSON:API request and response formatting and is authenticated with HTTP Basic credentials issued from the Flowroute portal. Endpoints cover number search, purchase, message send and lookup, and route configuration.

## For AI agents

Search and purchase phone numbers, send SMS and MMS messages, and configure call routes on Flowroute from agent code.

## Scope

Does not handle email delivery, push notifications, or video calls - use for Flowroute SMS, MMS, phone number provisioning, and call routing only.

## Capabilities

- Search the Flowroute inventory for available phone numbers by area code or rate center
- Purchase a number and assign it to your account through `/v2/numbers`
- Send SMS and MMS messages via the `/v2.2/messages` endpoint
- Look up the delivery status of a sent message by ID
- Configure inbound routes to direct calls and messages to your endpoints
- Retrieve metadata for a specific owned number
- Inspect routing rules attached to numbers

## Use cases

### Programmatic SMS Sending

Send transactional SMS - order confirmations, two-factor codes, appointment reminders - by calling POST `/v2.2/messages` with from, to, and body fields. Flowroute returns a message ID you can later use with GET `/v2.2/messages/{message_id}` to read delivery status. Integration takes a few hours including credential setup and inbound webhook handling.

Example prompt: Send an SMS via POST `/v2.2/messages` from a Flowroute-owned number to +14155551234 with the body 'Your code is 482915'.

### Phone Number Provisioning

Search Flowroute's inventory through GET `/v2/numbers/available` filtered by area code or rate center, then claim a number by posting to `/v2/numbers.` This suits agents that spin up dedicated numbers per campaign, customer, or test environment. The purchased number can immediately send and receive SMS and calls.

Example prompt: Search GET `/v2/numbers/available` for an SMS-capable number with area code 312 and purchase the first match via POST `/v2/numbers.`

### Inbound Call and Message Routing

Configure `/v2/routes` to point inbound calls and messages at the right SIP endpoint or HTTP webhook. Useful for agents that maintain multiple destinations - for example, routing support calls to a contact center and sales calls to a sales queue. Routes are attached to specific owned numbers.

Example prompt: Update `/v2/routes` to point a specified Flowroute number at a webhook URL for inbound SMS handling.

### AI Agent Telephony Integration via Jentic

Agents use Jentic's intent search to find Flowroute operations, load the schema for the SMS endpoint, and execute calls using a scoped credential. This is the recommended pattern for AI assistants that send verification codes or confirmations as part of a conversation. Jentic keeps the Basic auth credentials isolated.

Example prompt: Use Jentic to search 'send an SMS via Flowroute', load the POST `/v2.2/messages` schema, and send a message to the user's phone number with the verification code they requested.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v2/numbers/available` | Search inventory for available numbers |
| POST | `/v2/numbers` | Purchase a phone number |
| GET | `/v2/numbers/{number_id}` | Retrieve metadata for an owned number |
| POST | `/v2.2/messages` | Send an SMS or MMS message |
| GET | `/v2.2/messages/{message_id}` | Look up message delivery status |
| GET | `/v2/routes` | List configured inbound routes |

## Key resources

- **Numbers** — Search the inventory, purchase numbers, and inspect owned numbers.
- **Messages** — Send SMS and MMS messages and look up their delivery status.
- **Routes** — Configure inbound call and message routing for owned numbers.

## Why Jentic

- **Setup:** Wiring the Flowroute API by hand means encoding your Access Key and Secret Key into HTTP Basic auth, tracking the split between its v2 number endpoints and v2.2 messaging endpoints, and building your own retry and error handling. Through Jentic you install once, import Flowroute from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Flowroute carries the message recipient in the request body rather than the URL path, so scoping is operations-only: you limit the agent to the operations it needs, such as sending a message or listing available numbers, and leave out purchasing a number unless you add it. Every operation the agent can run is one you chose.
- **Credential handling:** Your Flowroute Access Key and Secret Key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send an SMS via Flowroute', and Jentic returns the POST `/v2.2/messages` operation with its input schema so the agent supplies from, to, and body without browsing the reference docs.

## Related APIs

- **Twilio API** — Mainstream global telephony platform with broader country coverage and richer voice features.
- **Sinch API** — Global SMS and voice provider with strong international reach.
- **SendGrid Mail API** — Email delivery to pair with Flowroute SMS for multi-channel notifications.

## FAQ

### Why is there no official OpenAPI spec for Flowroute Telephony API?

Flowroute does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Flowroute Telephony API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Flowroute Telephony API use?

The Flowroute Telephony API uses HTTP Basic authentication with an Access Key and Secret Key generated in the Flowroute portal. Jentic stores both halves encrypted in your Jentic One instance and constructs the Basic header on outbound calls.

### Can I send MMS messages with the Flowroute Telephony API?

Yes, POST `/v2.2/messages` accepts both SMS and MMS payloads. Include media URLs for MMS and use a number that has MMS enabled in Flowroute's inventory.

### What are the rate limits for the Flowroute Telephony API?

The OpenAPI spec does not declare explicit rate limits. Flowroute applies messaging throughput limits per number based on the number type (long code, toll-free, short code) - back off on 429 responses and consult Flowroute support for higher throughput.

### How do I purchase a phone number through Jentic?

Search Jentic for 'buy a Flowroute phone number', load the GET `/v2/numbers/available` schema to find a candidate, then load and execute POST `/v2/numbers` to claim it. The new number is immediately usable for SMS and calls.

### Does the Flowroute Telephony API use the JSON:API format?

Yes, both requests and responses follow JSON:API conventions. Payloads are wrapped in 'data' objects with 'type' and 'attributes' fields. Jentic handles this wrapping automatically when an agent executes the tool.

### Can I limit what my agent is allowed to do with the Flowroute Telephony API?

Yes. Because Flowroute carries the message recipient in the request body rather than the URL path, scoping is done at the operation level in your own self-hosted Jentic One instance, where your rules decide which operations and credentials the agent may use. You can allow only the operations the agent needs, such as sending a message via POST `/v2.2/messages` or listing available numbers via GET `/v2/numbers/available`, while leaving out purchasing a number through POST `/v2/numbers` unless you add it. Every operation the agent can run is one you chose.