Comece aqui

Sua primeira solicitação em quatro etapas

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.

Conta abrangida

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.

Autenticação

Mantenha as credenciais no seu servidor

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.

Antes de integrar

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.

PEGAR

List Workflow Studio workflows

FIMhttps://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.

Quando usá-lo

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

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Your account API key. You may instead use an Authorization: Bearer header.
`page`	inteiro	Opcional	Page number. Default 1.
`per_page`	inteiro	Opcional	Rows per page. Default 25, maximum 100.
`search`	corda	Opcional	Search the workflow name, description or UUID.
`event_type`	corda	Opcional	Return only workflows using this exact event, for example sms.received.
`active`	boolean	Opcional	Use 1 or 0 to filter active or paused workflows.
`favorite`	boolean	Opcional	Use 1 or 0 to filter mobile favorites.
`include_definition`	boolean	Opcional	Default 1. Set to 0 to omit conditions, actions and schedule details.

Exemplo de solicitação

enrolar

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

Exemplo de resposta

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

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

PUBLICAR

Activate or pause a workflow

FIMhttps://api.smsmobileapi.com/workflow/state/

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

Quando usá-lo

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

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Your account API key. You may instead use an Authorization: Bearer header.
`workflow_uuid`	corda	Obrigatório	Public, stable workflow identifier returned by the list endpoint.
`active`	boolean	Obrigatório	1 activates the workflow; 0 pauses it.

Exemplo de solicitação

enrolar

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

Exemplo de resposta

JSON

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

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

This operation never changes the workflow definition.
Already queued actions are not cancelled when a workflow is paused.

PUBLICAR

Add or remove a mobile favorite

FIMhttps://api.smsmobileapi.com/workflow/favorite/

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

Quando usá-lo

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

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Your account API key. You may instead use an Authorization: Bearer header.
`workflow_uuid`	corda	Obrigatório	Public, stable workflow identifier returned by the list endpoint.
`favorite`	boolean	Obrigatório	1 adds the workflow to favorites; 0 removes it.

Exemplo de solicitação

enrolar

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

Exemplo de resposta

JSON

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

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

PEGAR

List one workflow’s execution logs

FIMhttps://api.smsmobileapi.com/workflow/logs/

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

Quando usá-lo

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

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Your account API key. You may instead use an Authorization: Bearer header.
`workflow_uuid`	corda	Obrigatório	Public, stable workflow identifier returned by the list endpoint.
`status`	corda	Opcional	Filter by matched, skipped, queued, running, completed, failed, cancelled, credit_required or test.
`page`	inteiro	Opcional	Page number. Default 1.
`per_page`	inteiro	Opcional	Rows per page. Default 25, maximum 100.
`include_details`	boolean	Opcional	Default 1. Set to 0 to omit input and condition trace details.

Exemplo de solicitação

enrolar

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

Exemplo de resposta

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

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

A completed run represents a successfully finalized workflow execution.
The request_id can be included in a support request without revealing the API key.

Solução de problemas

Erros e novas tentativas seguras

Leia o status HTTP e o campo de erro JSON antes de tentar novamente. Não tente novamente falhas de validação ou autenticação sem primeiro corrigir a solicitação.

HTTP	Código	O que fazer
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.

Regra de nova tentativaTente novamente apenas respostas transitórias 429 e 5xx. Comece após 1 segundo e depois volte para 2, 4 e 8 segundos.

Precisar de ajuda?

Traga o contexto da solicitação, não seus segredos.

Compartilhe o endpoint, o carimbo de data/hora, o status HTTP e a resposta limpa. Nunca inclua chaves de API, tokens ou conteúdo de mensagens privadas.

Entre em contato com o suporte da API →

O aplicativo móvel SMSMobileAPI seguro conectando um telefone ao painel web e REST API para operações de SMS e chamada — Ligação móvel-plataforma criptografada

Aplicação móvel oficial

A ponte segura entre o telefone, o painel e o API.

As operações de SMS e chamada passam pelo aplicativo oficial SMSMobileAPI instalado em seu telefone conectado. O aplicativo combina o dispositivo com sua conta, sincroniza eventos autorizados e liga a rede móvel ao painel de bordo e REST API.

1Aplicativo móvelEmparelha o telefone com o seu SIM 2Ligação criptografadaAutentica e protege dados em trânsito 3Painel de controle e APIControla fluxos de trabalho e atividade

Lançamentos assinados distribuídos através das listas oficiais do Google Play e Apple App Store
Controles de revisão, assinatura e distribuição da plataforma Google e Apple
Emparelhamento seguro de dispositivo, transporte HTTPS e acesso autenticado API
Apenas as permissões necessárias para as funcionalidades móveis que activa

Obtenha o aplicativo oficial SMSMobileAPI no Google Play

Baixe o aplicativo oficial SMSMobileAPI na Apple App Store

As capacidades dependem das permissões e do acesso de fundo permitidos pelo Android ou iOS.

Workflow Studio API documentation

Sua primeira solicitação em quatro etapas

Discover workflows

Activate or pause

Manage mobile modes

Follow each execution

Mantenha as credenciais no seu servidor

Parâmetros

Exemplo de solicitação

Exemplo de resposta

Parâmetros

Exemplo de solicitação

Exemplo de resposta

Parâmetros

Exemplo de solicitação

Exemplo de resposta

Parâmetros

Exemplo de solicitação

Exemplo de resposta

Erros e novas tentativas seguras

Traga o contexto da solicitação, não seus segredos.

A ponte segura entre o telefone, o painel e o API.