Ваши SMS отправляются с вашего телефона.Узнайте, как это работает
ПЛАТФОРМАAPI первая архитектураЗащищенное устройствоВидимость доставкиМногофункциональный контрольВерсионная документация
Разработчик Hub/ Workflow Studio API

FLOW · 4 документированные операции

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

JSON ответы · HTTPS требуется · UTF-8

Подключите ключ API

Подключитесь один раз, затем проверьте конечные точки через SMS, звонки, уведомления, WhatsApp и электронную почту.

Начни здесь

Ваш первый запрос в четыре этапа

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.

Счет охватил

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.

Аутентификация

Держите учетные данные на своем сервере

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.

Прежде чем интегрировать
  • 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.
ПОЛУЧАТЬ

List Workflow Studio workflows

#
Смыслhttps://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.

Когда использовать его

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

Параметры

ИмяТипТребованиеОписание
apikey нить Необходимый Your account API key. You may instead use an Authorization: Bearer header.
page целое число факультативный Page number. Default 1.
per_page целое число факультативный Rows per page. Default 25, maximum 100.
search нить факультативный Search the workflow name, description or UUID.
event_type нить факультативный Return only workflows using this exact event, for example sms.received.
active boolean факультативный Use 1 or 0 to filter active or paused workflows.
favorite boolean факультативный Use 1 or 0 to filter mobile favorites.
include_definition boolean факультативный Default 1. Set to 0 to omit conditions, actions and schedule details.

Запросить пример

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

Пример ответа

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

Хотите выполнить этот запрос?Подключите ключ API в верхней части страницы, чтобы разблокировать интерактивный тестер.

Подключите ключ ↑
ПОЧТА

Activate or pause a workflow

#
Смыслhttps://api.smsmobileapi.com/workflow/state/

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

Когда использовать его

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

Параметры

ИмяТипТребованиеОписание
apikey нить Необходимый Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid нить Необходимый Public, stable workflow identifier returned by the list endpoint.
active boolean Необходимый 1 activates the workflow; 0 pauses it.

Запросить пример

кёрл
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}'

Пример ответа

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

Хотите выполнить этот запрос?Подключите ключ API в верхней части страницы, чтобы разблокировать интерактивный тестер.

Подключите ключ ↑
Хорошо знать
  • This operation never changes the workflow definition.
  • Already queued actions are not cancelled when a workflow is paused.
ПОЧТА

Add or remove a mobile favorite

#
Смыслhttps://api.smsmobileapi.com/workflow/favorite/

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

Когда использовать его

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

Параметры

ИмяТипТребованиеОписание
apikey нить Необходимый Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid нить Необходимый Public, stable workflow identifier returned by the list endpoint.
favorite boolean Необходимый 1 adds the workflow to favorites; 0 removes it.

Запросить пример

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

Пример ответа

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

Хотите выполнить этот запрос?Подключите ключ API в верхней части страницы, чтобы разблокировать интерактивный тестер.

Подключите ключ ↑
ПОЛУЧАТЬ

List one workflow’s execution logs

#
Смыслhttps://api.smsmobileapi.com/workflow/logs/

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

Когда использовать его

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

Параметры

ИмяТипТребованиеОписание
apikey нить Необходимый Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid нить Необходимый Public, stable workflow identifier returned by the list endpoint.
status нить факультативный Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
page целое число факультативный Page number. Default 1.
per_page целое число факультативный Rows per page. Default 25, maximum 100.
include_details boolean факультативный Default 1. Set to 0 to omit input and condition trace details.

Запросить пример

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

Пример ответа

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

Хотите выполнить этот запрос?Подключите ключ API в верхней части страницы, чтобы разблокировать интерактивный тестер.

Подключите ключ ↑
Хорошо знать
  • A completed run represents a successfully finalized workflow execution.
  • The request_id can be included in a support request without revealing the API key.

Поиск неисправностей

Ошибки и безопасные повторы

Прочитайте статус HTTP и поле ошибок JSON перед повторным использованием. Не повторяйте валидацию или сбои аутентификации без предварительного исправления запроса.

HTTPКодЧто делать
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.
Правило повторного использованияПовторите только временные ответы 429 и 5xx. Начните через 1 секунду, затем отойдите на 2, 4 и 8 секунд.

Нужна помощь?

Приведите контекст запроса, а не ваши секреты.

Поделитесь конечной точкой, временной меткой, статусом HTTP и дезинфицированным ответом. Никогда не включайте ключи API, токены или содержимое личных сообщений.

Поддержка API
Безопасное мобильное приложение SMSMobileAPI, подключающее телефон к веб-панели управления и REST API для SMS и операций вызова
Зашифрованное мобильное-платформенное соединение

Официальное мобильное приложение

Защищенный мост между телефоном, приборной панелью и API.

Операции SMS и вызова проходят через официальное приложение SMSMobileAPI, установленное на подключенном телефоне. Приложение надежно соединяет устройство с вашей учетной записью, синхронизирует авторизованные события и связывает мобильную сеть с приборной панелью и REST API.

1Мобильное приложениеПары телефона и его SIM 2Зашифрованная ссылкаАутентификация и защита данных при транзите 3Обновление APIКонтролирует рабочие процессы и активность
  • Подписанные релизы, распространяемые через официальные списки Google Play и Apple App Store
  • Google и Apple анализируют, подписывают и контролируют дистрибуцию
  • Защищенное сопряжение устройств, транспортировка HTTPS и аутентифицированный доступ к API
  • Только разрешения, необходимые для мобильных функций, которые вы включаете
Получите официальное приложение SMSMobileAPI в Google Play Скачать официальное приложение SMSMobileAPI в Apple App Store
Возможности зависят от разрешений и фонового доступа, разрешенных Android или iOS.