Vos SMS partent de votre propre mobile.Découvrez comment
PLATFORMEArchitecture API-premièreJumelage sécurisé de l'appareilVisibilité de la livraisonContrôle multi-appareilsDocumentation en version
Hub des développeurs/ Workflow Studio API

FLOW · 4 opérations documentées

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
URL de base RESThttps://api.smsmobileapi.com

Réponses JSON · HTTPS requis · UTF-8

Connectez votre clé API

Connectez-vous une fois, puis testez les points de terminaison via SMS, appels, notifications, WhatsApp et e-mail.

Commencez ici

Votre première demande en quatre étapes

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.

Compte couvert

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.

Authentification

Conservez les informations d'identification sur votre serveur

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.

Avant l'intégration
  • 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.
OBTENIR

List Workflow Studio workflows

#
POINT D'ARRIVÉEhttps://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.

Quand l'utiliser

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

Paramètres

NomTaperExigenceDésignation des marchandises
apikey chaîne Requis Your account API key. You may instead use an Authorization: Bearer header.
page entier Facultatif Page number. Default 1.
per_page entier Facultatif Rows per page. Default 25, maximum 100.
search chaîne Facultatif Search the workflow name, description or UUID.
event_type chaîne Facultatif Return only workflows using this exact event, for example sms.received.
active boolean Facultatif Use 1 or 0 to filter active or paused workflows.
favorite boolean Facultatif Use 1 or 0 to filter mobile favorites.
include_definition boolean Facultatif Default 1. Set to 0 to omit conditions, actions and schedule details.

Exemple de demande

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

Exemple de réponse

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

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑
POSTE

Activate or pause a workflow

#
POINT D'ARRIVÉEhttps://api.smsmobileapi.com/workflow/state/

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

Quand l'utiliser

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

Paramètres

NomTaperExigenceDésignation des marchandises
apikey chaîne Requis Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid chaîne Requis Public, stable workflow identifier returned by the list endpoint.
active boolean Requis 1 activates the workflow; 0 pauses it.

Exemple de demande

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

Exemple de réponse

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

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑
Bien pour savoir
  • This operation never changes the workflow definition.
  • Already queued actions are not cancelled when a workflow is paused.
POSTE

Add or remove a mobile favorite

#
POINT D'ARRIVÉEhttps://api.smsmobileapi.com/workflow/favorite/

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

Quand l'utiliser

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

Paramètres

NomTaperExigenceDésignation des marchandises
apikey chaîne Requis Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid chaîne Requis Public, stable workflow identifier returned by the list endpoint.
favorite boolean Requis 1 adds the workflow to favorites; 0 removes it.

Exemple de demande

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

Exemple de réponse

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

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑
OBTENIR

List one workflow’s execution logs

#
POINT D'ARRIVÉEhttps://api.smsmobileapi.com/workflow/logs/

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

Quand l'utiliser

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

Paramètres

NomTaperExigenceDésignation des marchandises
apikey chaîne Requis Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid chaîne Requis Public, stable workflow identifier returned by the list endpoint.
status chaîne Facultatif Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
page entier Facultatif Page number. Default 1.
per_page entier Facultatif Rows per page. Default 25, maximum 100.
include_details boolean Facultatif Default 1. Set to 0 to omit input and condition trace details.

Exemple de demande

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

Exemple de réponse

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

Vous souhaitez exécuter cette requête ?Connectez votre clé API en haut de la page pour déverrouiller le testeur interactif.

Clé de connexion ↑
Bien pour savoir
  • A completed run represents a successfully finalized workflow execution.
  • The request_id can be included in a support request without revealing the API key.

Dépannage

Erreurs et tentatives sécurisées

Lisez l'état HTTP et le champ d'erreur JSON avant de réessayer. Ne réessayez pas les échecs de validation ou d'authentification sans d'abord corriger la demande.

HTTPCodeQue faire
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.
Règle de nouvelle tentativeRéessayez uniquement les réponses 429 et 5xx transitoires. Commencez après 1 seconde, puis revenez à 2, 4 et 8 secondes.

Besoin d'aide ?

Apportez le contexte de la requête, pas vos secrets.

Partagez le point de terminaison, l'horodatage, l'état HTTP et la réponse nettoyée. N'incluez jamais de clés API, de jetons ou de contenu de message privé.

Contactez l'assistance API →
L'application mobile sécurisée SMSMobileAPI connectant un téléphone au tableau de bord Web et à l'API REST pour les opérations SMS et d'appel
Connexion mobile à plateforme cryptée

Application mobile officielle

Le pont sécurisé entre votre téléphone, votre tableau de bord et votre API.

Les opérations SMS et appels passent par l'application officielle SMSMobileAPI installée sur votre téléphone connecté. L'application associe en toute sécurité l'appareil à votre compte, synchronise les événements autorisés et relie le réseau mobile au tableau de bord et à l'API REST.

1Application mobileAssocie le téléphone et sa carte SIM 2Lien cryptéAuthentifie et protège les données dans transit 3Tableau de bord et APIContrôle les flux de travail et l'activité
  • Communications signées distribuées via les listes officielles de Google Play et Apple App Store
  • Contrôles d'examen, de signature et de distribution des plateformes Google et Apple
  • Couplage sécurisé des appareils, transport HTTPS et accès API authentifié
  • Uniquement les autorisations requises pour les fonctionnalités mobiles que vous activez
Obtenez l'application officielle SMSMobileAPI sur Google Play Téléchargez l'application officielle SMSMobileAPI sur l'App Store d'Apple
Les fonctionnalités dépendent des autorisations et de l'accès en arrière-plan autorisés par Android ou iOS.