Aloita tästä.

Ensimmäinen pyyntösi neljässä vaiheessa

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

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

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

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

ONE WORKFLOW, EVERY INTERFACE

Control the same automations everywhere.

Tilin laajennetut

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.

Todennus

Pidä tiedot palvelimellasi

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.

Ennen kuin yhdistät

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.

SAADA

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.

Milloin sitä käytetään

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

Parametrit

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

Esimerkki pyynnön esittämisestä

kiemura

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

Esimerkkivastaus

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

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑

LÄHETTÄÄ

Activate or pause a workflow

endpointhttps://api.smsmobileapi.com/workflow/state/

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

Milloin sitä käytetään

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

Parametrit

Nimi	Tyyppi	Vaatimus	Kuvaus
`apikey`	jono	Pakollinen	Your account API key. You may instead use an Authorization: Bearer header.
`workflow_uuid`	jono	Pakollinen	Public, stable workflow identifier returned by the list endpoint.
`active`	boolean	Pakollinen	1 activates the workflow; 0 pauses it.

Esimerkki pyynnön esittämisestä

kiemura

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

Esimerkkivastaus

JSON

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

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑

Hyvä tietää

This operation never changes the workflow definition.
Already queued actions are not cancelled when a workflow is paused.

LÄHETTÄÄ

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.

Milloin sitä käytetään

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

Parametrit

Nimi	Tyyppi	Vaatimus	Kuvaus
`apikey`	jono	Pakollinen	Your account API key. You may instead use an Authorization: Bearer header.
`workflow_uuid`	jono	Pakollinen	Public, stable workflow identifier returned by the list endpoint.
`favorite`	boolean	Pakollinen	1 adds the workflow to favorites; 0 removes it.

Esimerkki pyynnön esittämisestä

kiemura

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

Esimerkkivastaus

JSON

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

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑

SAADA

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.

Milloin sitä käytetään

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

Parametrit

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

Esimerkki pyynnön esittämisestä

kiemura

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

Esimerkkivastaus

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

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑

Hyvä tietää

A completed run represents a successfully finalized workflow execution.
The request_id can be included in a support request without revealing the API key.

Vianetsintä

Virheet ja turvalliset korjaukset

Lue HTTP- tila ja JSON- virhekenttä ennen kuin yrität uudelleen. Älä yritä uudelleen validointi- tai tunnistusvirheitä korjaamatta ensin pyyntöä.

HTTP	Koodi	Mitä tehdä?
400	`missing_apikey`	No apikey parameter or Bearer token was supplied.
401	`invalid_apikey`	The API key is unknown or disabled.
404	`workflow_not_found`	The workflow does not exist or does not belong to the authenticated account.
422	`invalid_parameter`	A state, favorite, identifier, status or filter value is invalid.
423	`confidential_mode_active`	Standard API access is locked while Confidential Mode is active.
503	`service_unavailable`	Workflow Studio storage or account validation is temporarily unavailable.

Yritä uudelleen sääntöKokeile vain ohimeneviä 429 ja 5xx-vasteita. Aloita 1 sekunnin jälkeen ja peräänny 2, 4 ja 8 sekunnin kuluttua.

Tarvitsetko apua?

Tuo pyyntö kontekstia. Ei salaisuuksia.

Jaa päätepiste, aikaleima, HTTP-status ja puhdistava vaste. Älä koskaan sisälly API-näppäimiin, rahakkeisiin tai yksityiseen viestisisältöön.

Ota yhteyttä API-tukeen →

Turvallinen SMSMobileAPI-mobiilisovellus, joka yhdistää puhelimen verkkokojelautaan ja REST API-sovellus SMS- ja puhelutoimintoihin — Salattu mobiili-lautalta-liitäntä

Virallinen mobiilisovellus

Turvallinen silta puhelimen, kojelauta ja API:n välillä.

SMS- ja puhelutoiminnot kulkevat puhelimeen asennetun virallisen SMSMobileAPI-sovelluksen kautta. Sovellus yhdistää laitteen turvallisesti tiliisi, synkronoi hyväksytyt tapahtumat ja linkittää mobiiliverkon kojelautaan ja REST API:iin.

1MobiilisovellusParittele puhelin ja sen SIM 2Salattu linkkiTunnistaa ja suojaa tietoja kauttakulussa 3& APIHallitsee työnkulkua ja toimintaa

Allekirjoitetut tiedotteet, jotka on jaettu virallisten Google Play- ja Apple App Store -listausten kautta
Google ja Apple -alustan katselmointi, allekirjoittaminen ja jakelun valvonta
Turvalaiteparitus, HTTPS-kuljetus ja aito API-yhteys
Vain mobiiliominaisuuksille tarvittavat oikeudet

Hanki virallinen SMSMobileAPI-sovellus Google Playsta

Lataa Apple App Storen virallinen SMSMobileAPI-sovellus

Kyvyt riippuvat Android:n tai iOS:n sallimista käyttöoikeuksista ja tausta-aineistoista.

Workflow Studio API documentation

Ensimmäinen pyyntösi neljässä vaiheessa

Discover workflows

Activate or pause

Manage mobile modes

Follow each execution

Pidä tiedot palvelimellasi

Parametrit

Esimerkki pyynnön esittämisestä

Esimerkkivastaus

Parametrit

Esimerkki pyynnön esittämisestä

Esimerkkivastaus

Parametrit

Esimerkki pyynnön esittämisestä

Esimerkkivastaus

Parametrit

Esimerkki pyynnön esittämisestä

Esimerkkivastaus

Virheet ja turvalliset korjaukset

Tuo pyyntö kontekstia. Ei salaisuuksia.

Turvallinen silta puhelimen, kojelauta ja API:n välillä.