SMS mesajlarınız kendi telefonunuzdan gönderilir.Nasıl çalıştığını öğrenin
PLATFORMFORMFORMAPI-ilk mimarlıkGüvenli cihaz çiftleşiyorTeslimat görünürlüğü görünürlüğüMulti-device kontrolüVersioned documents
Geliştirici merkezi/ Workflow Studio API

FLOW · 4 belgelenmiş işlemler

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

JSON yanıtları · HTTPS gerekli · UTF-8

API anahtarını bağlayın

Bir kez, SMS'deki uç noktaları test edin, aramalar, bildirimler, WhatsApp ve e-posta.

Buraya başlayın

İlk isteğiniz dört adımda

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.

Hesap kapsamı

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.

Kimlik doğrulama

Kimlik bilgilerini sunucunuzda tutun

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.

entegre etmeden önce bütünleşmeden önce
  • 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.
ELDE ETMEK

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.

Ne zaman kullanılmalı

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

Parametreler

AdTürGereklilikTanım
apikey dize Gerekli Your account API key. You may instead use an Authorization: Bearer header.
page Tamsa Seçmeli Page number. Default 1.
per_page Tamsa Seçmeli Rows per page. Default 25, maximum 100.
search dize Seçmeli Search the workflow name, description or UUID.
event_type dize Seçmeli Return only workflows using this exact event, for example sms.received.
active boolean Seçmeli Use 1 or 0 to filter active or paused workflows.
favorite boolean Seçmeli Use 1 or 0 to filter mobile favorites.
include_definition boolean Seçmeli Default 1. Set to 0 to omit conditions, actions and schedule details.

Örneğin

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

Örnek yanıt

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

Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.

Anahtarı bağlayın ↑
POSTALAMAK

Activate or pause a workflow

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

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

Ne zaman kullanılmalı

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

Parametreler

AdTürGereklilikTanım
apikey dize Gerekli Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid dize Gerekli Public, stable workflow identifier returned by the list endpoint.
active boolean Gerekli 1 activates the workflow; 0 pauses it.

Örneğin

kıvrımlı
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}'

Örnek yanıt

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

Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.

Anahtarı bağlayın ↑
İyi bilmek
  • This operation never changes the workflow definition.
  • Already queued actions are not cancelled when a workflow is paused.
POSTALAMAK

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.

Ne zaman kullanılmalı

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

Parametreler

AdTürGereklilikTanım
apikey dize Gerekli Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid dize Gerekli Public, stable workflow identifier returned by the list endpoint.
favorite boolean Gerekli 1 adds the workflow to favorites; 0 removes it.

Örneğin

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

Örnek yanıt

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

Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.

Anahtarı bağlayın ↑
ELDE ETMEK

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.

Ne zaman kullanılmalı

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

Parametreler

AdTürGereklilikTanım
apikey dize Gerekli Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid dize Gerekli Public, stable workflow identifier returned by the list endpoint.
status dize Seçmeli Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
page Tamsa Seçmeli Page number. Default 1.
per_page Tamsa Seçmeli Rows per page. Default 25, maximum 100.
include_details boolean Seçmeli Default 1. Set to 0 to omit input and condition trace details.

Örneğin

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

Örnek yanıt

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

Bu isteği çalıştırmak ister misiniz?API anahtarını interaktif testleyiciyi kilidini açmak için sayfanın başında bağlayın.

Anahtarı bağlayın ↑
İyi bilmek
  • A completed run represents a successfully finalized workflow execution.
  • The request_id can be included in a support request without revealing the API key.

Sorun giderme

Hatalar ve güvenli yenidenrries

HTTP statüsünü ve JSON hata alanını yeniden denemeden önce okuyun. İstekyi ilk önce düzeltmeden doğrulama veya doğrulama başarısızlıklarını yeniden denemeyin.

HTTPKod Kodu KoduNe yapmalı
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.
Yeniden deneme kuralıYeniden deneme sadece 429 ve 5xx yanıtlarını geçici olarak yeniden deneyin. 1 saniye sonra, sonra 2, 4 ve 8 saniyeye kadar geri başlayın.

Yardıma mı ihtiyacınız var?

İstek bağlamını getir - sırlarınız değil.

Son noktayı paylaşın, zamantamp, HTTP durumu ve sanitized yanıt. API anahtarlarını, jetonları veya özel mesaj içeriğini asla dahil etmeyin.

İletişim API destek
Güvenli SMSMobileAPI mobil uygulama bir telefona web paniğe ve REST API'e SMS için bir telefon ve operasyon çağrısı
Şifrelenmiş mobil platform bağlantı bağlantı bağlantı

Resmi mobil uygulama

Telefonunuz, kontrol paneliniz ve API arasındaki güvenli köprü.

SMS ve çağrı işlemleri, bağlı telefonunuza yüklenen resmi SMSMobileAPI uygulaması üzerinden geçer. Uygulama, cihazı güvenli bir şekilde hesabınızla eşleştirir, yetkili etkinlikleri senkronize eder ve mobil ağı kontrol paneline ve REST API'ye bağlar.

1Mobil uygulamaTelefonu ve SIM'ini eşler 2Şifreli bağlantıAktarım halindeki verileri doğrular ve korur 3Kontrol Paneli ve APIİş akışlarını ve etkinliği kontrol eder
  • Resmi Google Play ve Apple App Store listeleri aracılığıyla dağıtılan imzalı sürümler
  • Google ve Apple platform incelemesi, imzalama ve dağıtım kontrolleri
  • Güvenli cihaz eşleştirme, HTTPS aktarımı ve kimlik doğrulamalı API erişimi
  • Yalnızca etkinleştirdiğiniz mobil özellikler için gerekli izinler
Google Play'de resmi SMSMobileAPI uygulamasını alın Apple App Store'da resmi SMSMobileAPI uygulamasını indirin
Yetenekler, Android