SMS được gửi từ chính điện thoại của bạn.Tìm hiểu cách hoạt động
PLATORMKiến trúc API- thứ nhấtSự kết hợp thiết bị bảo mậtTầm nhìn giao hàngĐiều khiển nhiều khả năngTài liệu đã phiên bản
Trung tâm nhà phát triển/ Workflow Studio API

FLOW · 4 các thao tác có tài liệu

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 cơ sở RESThttps://api.smsmobileapi.com

JSON đáp ứng · HTTPS yêu cầu · UTF-8

Kết nối phím API của bạn

Kết nối một lần, sau đó kiểm tra kết thúc qua tin nhắn, thông báo, WhatsApp và email.

Bắt đầu từ đây

Yêu cầu đầu tiên của bạn trong bốn bước

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.

Tài khoản đã được thu nhỏ

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.

Xác thực

Giữ thẻ trên máy chủ

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.

Trước khi bạn tích hợp
  • 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.
LẤY

List Workflow Studio workflows

#
QUAN ĐIỂM cuốihttps://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.

Khi nào dùng nó

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

Các tham số

TênKiểuCần thiếtSự miêu tả
apikey sợi dây Yêu cầu Your account API key. You may instead use an Authorization: Bearer header.
page Số nguyên Tùy chọn Page number. Default 1.
per_page Số nguyên Tùy chọn Rows per page. Default 25, maximum 100.
search sợi dây Tùy chọn Search the workflow name, description or UUID.
event_type sợi dây Tùy chọn Return only workflows using this exact event, for example sms.received.
active boolean Tùy chọn Use 1 or 0 to filter active or paused workflows.
favorite boolean Tùy chọn Use 1 or 0 to filter mobile favorites.
include_definition boolean Tùy chọn Default 1. Set to 0 to omit conditions, actions and schedule details.

Ví dụ yêu cầu

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

Ví dụ về câu trả lời

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

Muốn chạy yêu cầu này không?Kết nối phím API của bạn ở đầu trang để mở khóa bộ thử ra.

Phím kết nối Gỡ khóa
BƯU KIỆN

Activate or pause a workflow

#
QUAN ĐIỂM cuốihttps://api.smsmobileapi.com/workflow/state/

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

Khi nào dùng nó

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

Các tham số

TênKiểuCần thiếtSự miêu tả
apikey sợi dây Yêu cầu Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid sợi dây Yêu cầu Public, stable workflow identifier returned by the list endpoint.
active boolean Yêu cầu 1 activates the workflow; 0 pauses it.

Ví dụ yêu cầu

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

Ví dụ về câu trả lời

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

Muốn chạy yêu cầu này không?Kết nối phím API của bạn ở đầu trang để mở khóa bộ thử ra.

Phím kết nối Gỡ khóa
Thật tốt khi biết
  • This operation never changes the workflow definition.
  • Already queued actions are not cancelled when a workflow is paused.
BƯU KIỆN

Add or remove a mobile favorite

#
QUAN ĐIỂM cuốihttps://api.smsmobileapi.com/workflow/favorite/

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

Khi nào dùng nó

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

Các tham số

TênKiểuCần thiếtSự miêu tả
apikey sợi dây Yêu cầu Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid sợi dây Yêu cầu Public, stable workflow identifier returned by the list endpoint.
favorite boolean Yêu cầu 1 adds the workflow to favorites; 0 removes it.

Ví dụ yêu cầu

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

Ví dụ về câu trả lời

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

Muốn chạy yêu cầu này không?Kết nối phím API của bạn ở đầu trang để mở khóa bộ thử ra.

Phím kết nối Gỡ khóa
LẤY

List one workflow’s execution logs

#
QUAN ĐIỂM cuốihttps://api.smsmobileapi.com/workflow/logs/

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

Khi nào dùng nó

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

Các tham số

TênKiểuCần thiếtSự miêu tả
apikey sợi dây Yêu cầu Your account API key. You may instead use an Authorization: Bearer header.
workflow_uuid sợi dây Yêu cầu Public, stable workflow identifier returned by the list endpoint.
status sợi dây Tùy chọn Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
page Số nguyên Tùy chọn Page number. Default 1.
per_page Số nguyên Tùy chọn Rows per page. Default 25, maximum 100.
include_details boolean Tùy chọn Default 1. Set to 0 to omit input and condition trace details.

Ví dụ yêu cầu

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

Ví dụ về câu trả lời

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

Muốn chạy yêu cầu này không?Kết nối phím API của bạn ở đầu trang để mở khóa bộ thử ra.

Phím kết nối Gỡ khóa
Thật tốt khi biết
  • A completed run represents a successfully finalized workflow execution.
  • The request_id can be included in a support request without revealing the API key.

Xử lý sự cố

Lỗi và cách ghi lưu an toàn

Đọc trường lỗi HTTP và trường lỗi JSON trước khi thử lại. Đừng thử lại hiệu lực hoặc xác thực lỗi mà không sửa lại yêu cầu trước.

HTTPBộ mãLàm sao đây?
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.
Thử lại quy tắcThử lại chỉ 429 và 5xx. Bắt đầu sau 1 giây, rồi quay lại 2, 4 và 8 giây.

Bạn cần trợ giúp?

Hãy đưa ra yêu cầu về bối cảnh chứ không phải bí mật của bạn.

Chia sẻ điểm kết thúc, nhãn thời gian, trạng thái HTTP và phản ứng làm sạch. Không bao giờ bao gồm các phím API, vật thể hay tin nhắn riêng.

Liên lạc hỗ trợ API
An toàn.SMSMobileAPIỨng dụng di động kết nối điện thoại tới bảng điều khiển web và hệ thống điều khiển RT cho các thao tác tin nhắn và gọi
Kết nối kết nối mã hóa cho di động thành đơn vị mã hóa

Ứng dụng di động chính thức

Cầu bảo mật giữa điện thoại, bảng điều khiển và API.

Kết nối và gọi đến cho chính thứcSMSMobileAPIỨng dụng được cài đặt trên điện thoại kết nối của bạn. Ứng dụng này đảm bảo kết nối thiết bị này với tài khoản của bạn, đồng bộ hoá các sự kiện cho phép và kết nối mạng di động vào bảng điều khiển và hệ thống điều khiển.

1Ứng dụng Di độngChia đôi điện thoại và SIM 2Liên kết đã mã hóaXác thực và bảo vệ dữ liệu trong quá trình truyền 3Bảng & APIĐiều khiển dòng chảy và hoạt động
  • Ký giấy phát hành qua danh sách Google Play và Apple App Store chính thức
  • Xem lại nền tảng Google và Apple, ký và phân phối điều khiển
  • Hai thiết bị bảo mật, HTTPS vận chuyển và xác thực quyền truy cập API
  • Chỉ quyền hạn cần thiết cho các tính năng di động bạn bật
Lấy ứng dụng SMSMobileAPI chính thức trên Google Play Tải về ứng dụng SMSMobileAPI chính thức trên Apple App Store
Phụ thuộc vào quyền hạn và quyền truy cập nền do Android hay iOS cho phép.