ここから開始

4 つのステップで最初のリクエストを実行します

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

これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にある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"
}

これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にある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"
}

これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にある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"
}

これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にある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	コード	対処方法
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 応答と 5xx 応答のみを再試行します。 1 秒後に開始し、2 秒、4 秒、8 秒に戻ります。

ヘルプが必要ですか?

シークレットではなくリクエストコンテキストを提供します。

エンドポイント、タイムスタンプ、HTTP ステータス、サニタイズされたレスポンスを共有します。 API キー、トークン、プライベートメッセージコンテンツは決して含めないでください。

API サポートに問い合わせる →

安全な SMSMobileAPI モバイルアプリは、携帯電話をWebダッシュボードに接続し、SMS とコール操作のための REST API — 暗号化されたモバイル・ツー・プラットフォーム接続

オフィシャルモバイルアプリケーション

電話、ダッシュボード、API間の安全な橋。

SMS とコール操作は、接続された電話にインストールされている公式 SMSMobileAPI アプリを通過します。アプリは、アカウントでデバイスを安全にペアリングし、認定イベントを同期し、モバイルネットワークをダッシュボードとREST APIにリンクします。

1モバイルアプリ携帯電話とSIMをペアリング 2暗号化されたリンクデータをトランスイトで認証し、保護 3ダッシュボードとAPIワークフローとアクティビティの制御

正式なGoogle PlayとApple App Storeの一覧で配布されたサインされたリリース
GoogleとAppleプラットフォームのレビュー、署名、配布制御
セキュアなデバイスペアリング、HTTPS の輸送および認証 API アクセス
有効にできるモバイル機能に必要な権限のみ

Apple App Storeで公式SMSMobileAPIアプリをダウンロード

Android または iOS で許可されている許可と背景アクセスに応じて機能します。

Workflow Studio API documentation

4 つのステップで最初のリクエストを実行します

Discover workflows

Activate or pause

Manage mobile modes

Follow each execution

認証情報をサーバー上に保持します

パラメータ

リクエストの例

回答例

パラメータ

リクエストの例

回答例

パラメータ

リクエストの例

回答例

パラメータ

リクエストの例

回答例

エラーと安全な再試行

シークレットではなくリクエスト コンテキストを提供します。

電話、ダッシュボード、API間の安全な橋。

シークレットではなくリクエストコンテキストを提供します。