Документація API безкоштовного SMS-маркетингу

Посібник з інтеграції мобільного додатку

Базова URL https://api.rcszilla.com/?endpoint={endpoint}

Спочатку отримайте ваш API-ключ

Перед надсиланням безкоштовних SMS-маркетингових повідомлень створіть особистий API-ключ у веб-панелі. Цей ключ дозволяє вашому сайту, CRM або інструменту автоматизації звертатися до API напряму.

Увійдіть у веб-панель та перейдіть до Налаштування.
Прокрутіть до розділу API-ключ та натисніть Згенерувати ключ.
Скопіюйте ключ та використовуйте його в заголовку Authorization: Bearer ваших запитів.

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
}

Огляд API

Це REST API, який використовується Android-додатком RCSZilla та веб-панеллю для безкоштовного SMS-маркетингу. Використовуйте його для постановки повідомлень у чергу, звітування про статус доставки, надсилання вхідних відповідей та синхронізації конфігурації пристрою.

Усі запити та відповіді використовують JSON. Усі endpoints обслуговуються з https://api.rcszilla.com/ та вибираються через параметр ?endpoint=.

Формат запиту

Кожен запит повинен містити Content-Type: application/json та заголовок авторизації (крім claim_device, який є публічним).

HTTPПриклад запиту

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

Формат відповіді

Кожна відповідь є JSON-об'єктом. Успішні відповіді завжди містять "success": true. Помилки містять "success": false та поле "message".

JSONПриклад відповіді - success

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

JSONПриклад відповіді - error

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

Quick Reference

Endpoint	Метод	Автентифікація	Опис
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