GatewayAPI
Send single RCS-capable mobile messages and bounded SMS batches from a Swarmz project
Connect GatewayAPI when a project needs mobile notifications through GatewayAPI's global or EU service. Single-message sends use the Mobile Messaging API, which can deliver RCS where available and fall back to SMS. Batch sends use the documented SMS REST endpoint.
GatewayAPI is a shared workspace connection. App users do not authorize individual GatewayAPI accounts; the generated app decides who may send through the connected account.
Availability
A Swarmz administrator must show GatewayAPI under Platform config > Integrations. It does not require a Swarmz OAuth application.
Connect GatewayAPI
- In GatewayAPI, create an API token under API > Credentials. GatewayAPI documents token authentication.
- In the Swarmz project, open Settings > Integrations and select GatewayAPI.
- Enter the token in API key.
- In API domain, enter
globalforgatewayapi.comoreuforgatewayapi.eu. - Select Save connection.
Swarmz validates the token against the selected fixed domain. The field does not accept a custom URL.
Available operations
| Operation | What it does | Limit per minute |
|---|---|---|
send_message | Sends one mobile message with an optional reference, label, and priority | 10 |
send_batch | Sends one SMS body to 1 to 1,000 recipients | 5 |
Both operations require allow-once approval. Recipients are numeric MSISDN values including country code. Batch sending is capped below GatewayAPI's provider maximum so one AI action remains reviewable.
Ask the AI to use GatewayAPI
- “Send an order-ready mobile message and use the order ID as the reference.”
- “Notify these opted-in test numbers with one bounded SMS batch.”
- “Add a delivery callback endpoint to the project and match callbacks by the reference saved with each send.”
The AI requests GatewayAPI before wiring live sends. The connector performs outgoing requests only. Delivery reports and inbound messages go to an endpoint owned by the generated app, configured in GatewayAPI.
Configure and test callbacks
- Ask the AI to create a server-only callback endpoint that follows GatewayAPI's current webhook guidance.
- Store any callback verification secret through the project's secure secret form, not in browser code.
- Configure the published endpoint in GatewayAPI.
- Send a test message with a unique reference and confirm the callback updates the matching record.
Do not poll the connector for delivery state. GatewayAPI recommends callbacks, and the connector does not expose message-status polling.
Verify and recover
Send first to one controlled number. Confirm the send in GatewayAPI traffic logs, then confirm delivery through the app's callback record. Test a batch with two controlled recipients before increasing its size.
If setup fails, check that the token belongs to the selected global or EU domain. If a send is rejected, inspect sender rules, destination formatting, account credit, and country restrictions. Rotate a token by replacing it in Swarmz and sending one controlled message before revoking the old token.