Je SMS worden vanaf je eigen mobiel verstuurd.Ontdek hoe het werkt
PLATFORMAPI-eerste architectuurBeveiligde apparaat koppelingZichtbaarheid van de leveringMulti-apparaatbesturingVersiede documentatie
Ontwikkelaarshub/ Workflow Studio API

FLOW · 4 gedocumenteerde bewerkingen

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 basis-URLhttps://api.smsmobileapi.com

JSON responsen · HTTPS vereist · UTF-8

Sluit uw API-sleutel aan

Verbind eenmaal, test dan eindpunten over sms, oproepen, meldingen, WhatsApp en e-mail.

Start hier

Uw eerste verzoek in vier stappen

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.

Account-omschrijving

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.

Authenticatie

Houd referenties op uw 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.

Voordat u integreert
  • 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.
KRIJGEN

List Workflow Studio workflows

#
STOPPLIJThttps://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.

Wanneer moet u het gebruiken?

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

Parameters

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

Voorbeeld aanvragen

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

Voorbeeldantwoord

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"
}

Wil je dit verzoek doen?Sluit uw API-toets bovenaan de pagina aan om de interactieve tester te ontgrendelen.

Sleutel verbinden ↑
NA

Activate or pause a workflow

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

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

Wanneer moet u het gebruiken?

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

Parameters

NaamTypeVereistBeschrijving
apikey tekenreeks Vereist Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid tekenreeks Vereist Public, stable workflow identifier returned by the list endpoint.
active boolean Vereist 1 activates the workflow; 0 pauses it.

Voorbeeld aanvragen

krul
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}'

Voorbeeldantwoord

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

Wil je dit verzoek doen?Sluit uw API-toets bovenaan de pagina aan om de interactieve tester te ontgrendelen.

Sleutel verbinden ↑
Goed om te weten
  • This operation never changes the workflow definition.
  • Already queued actions are not cancelled when a workflow is paused.
NA

Add or remove a mobile favorite

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

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

Wanneer moet u het gebruiken?

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

Parameters

NaamTypeVereistBeschrijving
apikey tekenreeks Vereist Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid tekenreeks Vereist Public, stable workflow identifier returned by the list endpoint.
favorite boolean Vereist 1 adds the workflow to favorites; 0 removes it.

Voorbeeld aanvragen

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

Voorbeeldantwoord

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

Wil je dit verzoek doen?Sluit uw API-toets bovenaan de pagina aan om de interactieve tester te ontgrendelen.

Sleutel verbinden ↑
KRIJGEN

List one workflow’s execution logs

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

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

Wanneer moet u het gebruiken?

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

Parameters

NaamTypeVereistBeschrijving
apikey tekenreeks Vereist Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid tekenreeks Vereist Public, stable workflow identifier returned by the list endpoint.
status tekenreeks Facultatief Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
page geheel getal Facultatief Page number. Default 1.
per_page geheel getal Facultatief Rows per page. Default 25, maximum 100.
include_details boolean Facultatief Default 1. Set to 0 to omit input and condition trace details.

Voorbeeld aanvragen

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

Voorbeeldantwoord

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"
}

Wil je dit verzoek doen?Sluit uw API-toets bovenaan de pagina aan om de interactieve tester te ontgrendelen.

Sleutel verbinden ↑
Goed om te weten
  • A completed run represents a successfully finalized workflow execution.
  • The request_id can be included in a support request without revealing the API key.

Problemen oplossen

Fouten en veilige herhalingen

Lees de HTTP status en het JSON foutveld voordat u het opnieuw probeert. Probeer geen validatie of authenticatiefouten opnieuw zonder eerst het verzoek te corrigeren.

HTTPRubriekWat te doen?
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.
Regel opnieuw proberenProbeer slechts voorbijgaande 429 en 5xx responsen. Begin na 1 seconde, dan terug naar 2, 4 en 8 seconden.

Hulp nodig?

Breng de context van het verzoek en niet uw geheimen.

Deel het eindpunt, tijdstempel, HTTP status en gesanitiseerde respons. Neem nooit API sleutels, tokens of privé-inhoud van berichten.

Contact API ondersteuning →
De veilige SMSMobileAPI mobiele app die een telefoon verbindt met het webdashboard en REST API voor SMS- en oproepoperaties
Versleutelde mobiele-naar-platformverbinding

Officiële mobiele applicatie

De veilige brug tussen uw telefoon, dashboard en API.

SMS- en oproepoperaties gaan door via de officiële SMSMobileAPI-app die op uw aangesloten telefoon is geïnstalleerd. De app koppelt het apparaat veilig met uw account, synchroniseert geautoriseerde evenementen en koppelt het mobiele netwerk aan het dashboard en REST API.

1Mobiele appVergelijkt de telefoon en de SIM 2Versleutelde verwijzingAuthenticeert en beschermt gegevens tijdens de doorvoer 3Dashboard & APIControleert workflows en activiteit
  • Ondertekende releases verspreid via de officiële Google Play en Apple App Store lijsten
  • Google en Apple platform review, ondertekening en distributie controles
  • Veilige apparaat koppeling, HTTPS transport en geauthentiseerde API toegang
  • Alleen de rechten die nodig zijn voor de mobiele functies die u aanroept
Ontvang de officiële SMSMobileAPI-app op Google Play Download de officiële SMSMobileAPI-app in de Apple App Store
Mogelijkheden zijn afhankelijk van de toegangsrechten en achtergrondtoegang die door Android of iOS worden toegestaan.