短信从您自己的手机发出。了解工作原理
石窟画API 第一种架构安全设备配对交付可见度多设备控制已版本文件
开发者枢纽/ 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
REST 基础 URLhttps://api.smsmobileapi.com

· ZXX-10Z 答复 · ZX-11XZS 需要 · UTF-8

连接您的 API 密钥

连接一次,然后测试端点跨越短消息,电话,通知,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.

账户范围d

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 键以解锁交互式测试器 。

连接密钥 QQ
邮政

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 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 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 键以解锁交互式测试器 。

连接密钥 QQ
得到

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 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 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,用于短信和呼叫操作
加密的移动到平台连接

官方移动应用程序

电话、仪表板和API之间的安全桥

短信和呼叫业务通过官员SMSMobileAPI应用程序安装在您的连接电话上 。 应用软件安全地将设备与您的账户对齐,同步了授权的事件,并将移动网络连接到仪表板和REST API.

1移动应用程序给手机和它的SIM配对 2加密链接认证和保护过境数据 3发牌机和 API控制工作流程和活动
  • 通过Google Play和App Store官方上市发布签名的版本
  • Google和苹果平台审查、签署和发行控制
  • 安全设备对接、HTTPS运输和认证的API访问
  • 仅为您启用的移动特性所需的权限
找官来SMSMobileAPI应用程序在Google Play 下载苹果App Store上的官方SMSMobileAPI应用
能力取决于Android或iOS允许的权限和背景访问.