Почати

Ваш перший запит в чотири кроки

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.

Об'єм рахунку

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

ключ підключення ↑

Знайте

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

ключ підключення ↑

ОТРИМАТИ

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

ключ підключення ↑

Знайте

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	Коди	Що робити
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.

Правило птицяВідповідає лише транзистор 429 і 5xxx. Почати після 1 секунди, потім відключати до 2, 4 і 8 секунд.

Потрібна допомога?

Внести контекст запиту — не секрети.

Поділитися кінцевою точкою, часовим кроком, статус HTTP і санітарно-гігієнічним реагуванням. Ніколи не включають ключі API, токени або контент для приватного повідомлення.

Зв'язатися з API support →

Забезпечити мобільний додаток 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.

Workflow Studio API documentation

Ваш перший запит в чотири кроки

Discover workflows

Activate or pause

Manage mobile modes

Follow each execution

Збережіть облікові дані на сервері

Параметри

Приклад запиту

Приклад відповіді

Параметри

Приклад запиту

Приклад відповіді

Параметри

Приклад запиту

Приклад відповіді

Параметри

Приклад запиту

Приклад відповіді

Помилки та безпечні рети

Внести контекст запиту — не секрети.

Забезпечений міст між телефоном, панельом і API.