Documentação da API de Marketing por SMS Gratuito

Guia de Integração do Aplicativo Móvel

URL Base https://api.rcszilla.com/?endpoint={endpoint}

Obtenha Primeiro a Sua Chave de API

Antes de enviar mensagens de marketing por SMS gratuitas, crie uma chave de API pessoal no painel web. Essa chave permite que seu site, CRM ou ferramenta de automação chame a API diretamente.

Faça login no painel web e vá para Configurações.
Role até a seção Chave de API e clique em Gerar Chave.
Copie a chave e use-a no cabeçalho Authorization: Bearer das suas requisições.

Send a Test SMS

Paste your API key, enter a phone number and message, then queue a live SMS request.

JavaScript

API Key Endpoint Method

To Phone Channel Schedule Message

JSON Body / Query Parameters

https://api.rcszilla.com/?endpoint=queue_sms

{
  "status": "ready"
}

How to Send an SMS

Use queue_sms to add an outgoing SMS to the queue. The Android device/app sends it when it polls the API.

Endpoint	`POST https://api.rcszilla.com/?endpoint=queue_sms`
Auth	`Authorization: Bearer YOUR-API-KEY`
to	string	Recipient phone number, with country code recommended.
message	string	SMS text to send.
channel	string	Use `sms` (default). Also supports `whatsapp` and `email`. For `email`, `to` is an email address, `subject` is required, and `smtp_server_id` is optional (auto round-robin when omitted).
subject	string	Required when `channel=email`. Ignored for SMS/WhatsApp.
smtp_server_id	int	Optional. SMTP server to send the email through; omit to auto-rotate across your configured servers.
scheduled_at	string	Optional date/time in `YYYY-MM-DD HH:MM:SS` format.

cURLSend SMS

curl -X POST "https://api.rcszilla.com/?endpoint=queue_sms" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR-API-KEY" \
  -d "{\"to\":\"+40700000000\",\"message\":\"Hello from RCSZilla\",\"channel\":\"sms\"}"

JSONSuccess Response

{
  "success": true,
  "message": "Queued",
  "id": 123
}

Visão Geral da API

Esta é a API REST usada pelo aplicativo Android RCSZilla e pelo painel web para fluxos de trabalho de marketing por SMS gratuito. Use-a para enfileirar mensagens de saída, reportar o status de entrega, enviar respostas recebidas e sincronizar a configuração do dispositivo.

Todas as requisições e respostas usam JSON. Todos os endpoints são servidos a partir de https://api.rcszilla.com/ e são selecionados pelo parâmetro de consulta ?endpoint=.

Formato da Requisição

Toda requisição deve enviar Content-Type: application/json e um cabeçalho Authorization (exceto claim_device, que é público).

HTTPExemplo de Requisição

POST https://api.rcszilla.com/?endpoint=queue_sms HTTP/1.1
Host: api.rcszilla.com
Content-Type: application/json
Authorization: Bearer YOUR-API-KEY

{"to": "+40700000000", "message": "Hello from RCSZilla", "channel": "sms"}

Formato da Resposta

Toda resposta é um objeto JSON. Respostas bem-sucedidas sempre contêm "success": true. Falhas contêm "success": false e um campo "message".

JSONExemplo de Resposta - success

{
  "success": true,
  "message": "Queued",
  "id": 123
}

JSONExemplo de Resposta - error

{
  "success": false,
  "message": "id required"
}

Quick Reference

Endpoint	Método	Autenticação	Descrição
queue_sms	POST	Bearer	Queue an SMS, WhatsApp, or email message to send
claim_device	POST	-	Register a new device (public)
register_device	POST	Bearer	Update device metadata
pending_messages	GET	Bearer	Fetch outgoing message queue
mark_processing	POST	Bearer	Lock a message as in-progress
mark_sent	POST	Bearer	Report message sent
mark_delivered	POST	Bearer	Report delivery receipt
mark_failed	POST	Bearer	Report send failure
submit_reply	POST	Bearer	Submit an incoming message to inbox
queue_status	GET	Bearer	Get single message status
poll	POST	Bearer	Unified heartbeat + queue + config fetch
heartbeat	POST	Bearer	Device keep-alive (deprecated; use poll)
get_config	GET	Bearer	Fetch device configuration
log_outgoing	POST	Bearer	Log a directly-sent message
ack_commands	POST	Bearer	Acknowledge processed commands