This page describes the operational flow for SMS Gateway. Detailed request/response schemas live in the SMS-Gateway API reference tab.

End-to-end flow

1. •

   Provision workspace

   Enable SMS Gateway on your Aysali plan.

2. •

   Connect Android device

   Install app, enter API URL + Private Token, reach Online — Installation.

3. •

   Set API credentials (optional)

   From portal Status, configure API username/password for programmatic access.

4. •

   Authenticate integrations

   Use Basic auth or JWT tokens per endpoint requirements (see API reference Auth group).

5. •

   Send messages

   Queue SMS via portal test send or POST enqueue message API; device delivers via SIM.

6. •

   Track status

   Monitor Messages tab or poll/list message API; states progress to sent/delivered/failed.

7. •

   Receive inbound SMS

   Inbound messages sync to gateway; optionally forward via webhooks.

Authentication options

Method	Typical use
Private Token	Android app registration only
Basic auth	Server-side scripts with portal API username/password
JWT (Bearer)	Scoped automation tokens — generate via Auth endpoints

Open the matching Auth pages in the SMS-Gateway API tab for token lifecycle (create, refresh, revoke).

Core API areas

Area	What it does
Messages	Enqueue outbound SMS, list messages, export inbox
Devices	List and remove registered phones
Webhooks	Register URLs for events
Settings	Read/update gateway settings
Health	Readiness/liveness for monitoring
Mobile	Device-side endpoints used by the Android app

Webhooks

Register a webhook when your backend must react to:

• Outbound delivery state changes
• Inbound SMS arriving at a device

Configure from the portal (Webhooks dialog) or via API — see Portal guide.

Monitoring

• Portal Status health cards summarize gateway readiness.
• Use Health API endpoints for uptime checks in your monitoring stack.
• Logs (Manager tab / API) help diagnose failed sends.

Privacy

Review how the Android app handles data: Privacy Policy.

For developers

Browse endpoints by group in the SMS-Gateway tab:

Related