Dina SMS skickas från din egen mobil.Se hur det fungerar
PLATTFORMAPI-första arkitekturSäker enhet parningLeverans synlighetMulti-device kontrollVersioned dokumentation
Utvecklare hub/ Workflow Studio API

FLOW · 4 dokumenterade åtgärder

Workflow Studio API documentation

List Workflow Studio automations, activate or pause them, manage mobile favorites and inspect execution logs from your own software.

Workflow Studio events, conditions and actions connected through the API
REST bas URLhttps://api.smsmobileapi.com

JSON svar · HTTPS krävs · UTF-8

Anslut API-nyckeln

Anslut en gång, testa sedan slutpunkter över SMS, samtal, meddelanden, WhatsApp och e-post.

Börja här

Din första förfrågan i fyra steg

1

Create at least one workflow in Workflow Studio from the dashboard or mobile app.

2

Call the list endpoint with your account API key and keep the public workflow_uuid.

3

Use the state or favorite endpoint to update that exact workflow.

4

Retrieve its execution logs to follow conditions, actions, errors and credit status.

ONE WORKFLOW, EVERY INTERFACE

Control the same automations everywhere.

Kontot som omfattas

The API reads and updates the exact workflows used by the dashboard, the SMSMobileAPI mobile app and the asynchronous Workflow Studio worker. A state or favorite change is therefore visible everywhere without copying a definition.

LIST

Discover workflows

Retrieve identifiers, triggers, schedules, conditions, actions and execution counters.

CONTROL

Activate or pause

Build safe operational switches while keeping every workflow definition intact.

FAVORITE

Manage mobile modes

Choose which workflows appear as quick controls on the mobile app home screen.

LOGS

Follow each execution

Inspect decisions, action attempts, errors, completion and credit consumption.

Autentisering

Hålla referenser på din server

Send your account API key in the apikey parameter or as Authorization: Bearer YOUR_API_KEY. Every workflow lookup is scoped to that authenticated account. Keep the key on your server and never publish it in browser code, repositories, screenshots or public URLs.

Innan du integrerar
  • State and favorite changes are immediately shared with the dashboard and SMSMobileAPI mobile app.
  • Internal MySQL row identifiers are never exposed. Use the public workflow_uuid for every workflow operation.
  • Pausing a workflow prevents it from matching future events. It does not cancel actions that were already queued.
  • All dates returned by these endpoints use UTC.
FÅ

List Workflow Studio workflows

#
Endpointhttps://api.smsmobileapi.com/workflow/list/

Returns the workflows owned by the authenticated account, including their state, favorite flag, trigger, schedule, conditions, actions and execution counters.

När man ska använda den

Use it to build a workflow selector, synchronize another management interface or retrieve identifiers before calling another Workflow Studio endpoint.

Parametrar

NamnTypKravBeskrivning
apikey Sträng Nödvändig Your account API key. You may instead use an Authorization: Bearer header.
page Integer Optionell Page number. Default 1.
per_page Integer Optionell Rows per page. Default 25, maximum 100.
search Sträng Optionell Search the workflow name, description or UUID.
event_type Sträng Optionell Return only workflows using this exact event, for example sms.received.
active boolean Optionell Use 1 or 0 to filter active or paused workflows.
favorite boolean Optionell Use 1 or 0 to filter mobile favorites.
include_definition boolean Optionell Default 1. Set to 0 to omit conditions, actions and schedule details.

Begär exempel

ringla
curl "https://api.smsmobileapi.com/workflow/list/?apikey=YOUR_API_KEY&active=1&per_page=25"

Exempel svar

JSON
{
  "success": true,
  "data": [
    {
      "workflow_uuid": "wf_0123456789abcdef0123456789abcdef",
      "name": "Reply after a missed call",
      "event_type": "call.missed",
      "active": true,
      "favorite": true,
      "conditions": [],
      "actions": [{"type":"send_sms","config":{"recipient":"{{data.number}}","message":"We will call you back shortly."}}],
      "run_count": 18,
      "success_count": 18,
      "failed_count": 0
    }
  ],
  "pagination": {"page":1,"per_page":25,"total":1,"pages":1,"has_more":false},
  "request_id": "wfreq_4d9b7d7b2b8b384b2ad6f237"
}

Vill du köra denna begäran?Anslut din API-nyckel högst upp på sidan för att låsa upp den interaktiva testaren.

Anslut nyckel ^
POSTA

Activate or pause a workflow

#
Endpointhttps://api.smsmobileapi.com/workflow/state/

Changes whether one account-owned workflow listens for future events.

När man ska använda den

Use it to expose a controlled on/off switch in your own application or activate operational modes from another system.

Parametrar

NamnTypKravBeskrivning
apikey Sträng Nödvändig Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid Sträng Nödvändig Public, stable workflow identifier returned by the list endpoint.
active boolean Nödvändig 1 activates the workflow; 0 pauses it.

Begär exempel

ringla
curl -X POST "https://api.smsmobileapi.com/workflow/state/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workflow_uuid":"wf_0123456789abcdef0123456789abcdef","active":true}'

Exempel svar

JSON
{
  "success": true,
  "message": "Workflow activated.",
  "workflow": {"workflow_uuid":"wf_0123456789abcdef0123456789abcdef","active":true,"favorite":true},
  "applies_to": "future_events",
  "request_id": "wfreq_250c732826cc1833e28cf1cc"
}

Vill du köra denna begäran?Anslut din API-nyckel högst upp på sidan för att låsa upp den interaktiva testaren.

Anslut nyckel ^
Bra att veta
  • This operation never changes the workflow definition.
  • Already queued actions are not cancelled when a workflow is paused.
POSTA

Add or remove a mobile favorite

#
Endpointhttps://api.smsmobileapi.com/workflow/favorite/

Controls whether a workflow is displayed among the favorites available from the SMSMobileAPI mobile app home screen.

När man ska använda den

Use it to create quick-access modes such as Driving, Work, Family or On-call.

Parametrar

NamnTypKravBeskrivning
apikey Sträng Nödvändig Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid Sträng Nödvändig Public, stable workflow identifier returned by the list endpoint.
favorite boolean Nödvändig 1 adds the workflow to favorites; 0 removes it.

Begär exempel

ringla
curl -X POST "https://api.smsmobileapi.com/workflow/favorite/" \
  -d "apikey=YOUR_API_KEY" \
  -d "workflow_uuid=wf_0123456789abcdef0123456789abcdef" \
  -d "favorite=1"

Exempel svar

JSON
{
  "success": true,
  "message": "Workflow added to mobile favorites.",
  "workflow": {"workflow_uuid":"wf_0123456789abcdef0123456789abcdef","active":true,"favorite":true},
  "request_id": "wfreq_a9175f9b864aab7b998325b7"
}

Vill du köra denna begäran?Anslut din API-nyckel högst upp på sidan för att låsa upp den interaktiva testaren.

Anslut nyckel ^
FÅ

List one workflow’s execution logs

#
Endpointhttps://api.smsmobileapi.com/workflow/logs/

Returns paginated runs for one workflow with the event, status, condition trace, action attempts, errors and billing state.

När man ska använda den

Use it to display recent activity, diagnose a failed action or confirm that a workflow matched the expected event.

Parametrar

NamnTypKravBeskrivning
apikey Sträng Nödvändig Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid Sträng Nödvändig Public, stable workflow identifier returned by the list endpoint.
status Sträng Optionell Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
page Integer Optionell Page number. Default 1.
per_page Integer Optionell Rows per page. Default 25, maximum 100.
include_details boolean Optionell Default 1. Set to 0 to omit input and condition trace details.

Begär exempel

ringla
curl "https://api.smsmobileapi.com/workflow/logs/?apikey=YOUR_API_KEY&workflow_uuid=wf_0123456789abcdef0123456789abcdef&status=completed&per_page=25"

Exempel svar

JSON
{
  "success": true,
  "workflow": {"workflow_uuid":"wf_0123456789abcdef0123456789abcdef","name":"Reply after a missed call","event_type":"call.missed","active":true},
  "data": [
    {
      "event_uuid": "evt_01J8EXAMPLE9Q4V",
      "event_type": "call.missed",
      "status": "completed",
      "test_mode": false,
      "credit_status": "consumed",
      "created_at": "2026-10-06 08:14:21",
      "finished_at": "2026-10-06 08:14:22",
      "actions": [{"action_index":0,"action_type":"send_sms","status":"completed","attempts":1}]
    }
  ],
  "pagination": {"page":1,"per_page":25,"total":1,"pages":1,"has_more":false},
  "request_id": "wfreq_0a53eab7bef30e5ba52a0f86"
}

Vill du köra denna begäran?Anslut din API-nyckel högst upp på sidan för att låsa upp den interaktiva testaren.

Anslut nyckel ^
Bra att veta
  • A completed run represents a successfully finalized workflow execution.
  • The request_id can be included in a support request without revealing the API key.

Felsökning

Fel och säkra retries

Läs HTTP status och JSON felfältet innan du retryerar. Försök inte att fördröja validering eller autentiseringsfel utan att korrigera begäran först.

HTTPKodkodVad ska man göra
400missing_apikeyNo apikey parameter or Bearer token was supplied.
401invalid_apikeyThe API key is unknown or disabled.
404workflow_not_foundThe workflow does not exist or does not belong to the authenticated account.
422invalid_parameterA state, favorite, identifier, status or filter value is invalid.
423confidential_mode_activeStandard API access is locked while Confidential Mode is active.
503service_unavailableWorkflow Studio storage or account validation is temporarily unavailable.
Retry ruleRetry endast övergående 429 och 5xx svar. Börja efter 1 sekund, sedan tillbaka till 2, 4 och 8 sekunder.

Behöver du hjälp?

Ta med begäran kontext - inte dina hemligheter.

Dela slutpunkten, timestamp, HTTP status och sanitetssvar. Aldrig inkludera API nycklar, tokens eller privat meddelandeinnehåll.

Kontakta API support
Den säkra SMSMobileAPI mobilappen ansluter en telefon till webben instrumentpanelen och REST API för SMS och samtalsoperationer
Krypterad mobil-till-plattform-anslutning

Officiell mobilapplikation

Den säkra bron mellan din telefon, instrumentpanel och API.

SMS och samtalsoperationer passerar genom den officiella SMSMobileAPI-appen installerad på din anslutna telefon. Appen parar säkert enheten med ditt konto, synkroniserar auktoriserade händelser och länkar mobilnätet till instrumentpanelen och REST API.

1Mobilapp appPar telefonen och dess SIM 2Krypterad länkAutentiserar och skyddar data i transit 3Dashboard och APIKontroller arbetsflöden och aktivitet
  • Signerade releaser som distribueras via de officiella listorna Google Play och Apple App Store
  • Google och Apple plattformsgranskning, signering och distributionskontroller
  • Säkra enhet parning, HTTPS transport och autentiserad API tillgång
  • Endast de behörigheter som krävs för de mobila funktionerna du aktiverar
Få den officiella SMSMobileAPI-appen på Google Play Ladda ner den officiella SMSMobileAPI-appen på Apple App Store
Förmågor beror på behörigheter och bakgrundsåtkomst som tillåts av Android eller iOS.