RCSZilla Versiunea 1.0

Documentație API Marketing SMS Gratuit

Ghid de integrare aplicație mobilă

URL de bază https://api.rcszilla.com/?endpoint={endpoint}

Obțineți mai întâi cheia API

Înainte de a trimite mesaje SMS gratuite, creați o cheie API personală în panoul web. Această cheie permite site-ului dvs., CRM-ului sau instrumentului de automatizare să apeleze direct API-ul.

  1. Autentificați-vă în panoul web și mergeți la Setări.
  2. Derulați până la secțiunea Cheie API și faceți clic pe Generați cheie.
  3. Copiați cheia și folosiți-o în antetul Authorization: Bearer al cererilor dvs.

Send a Test SMS

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

JavaScript
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.

EndpointPOST https://api.rcszilla.com/?endpoint=queue_sms
AuthAuthorization: Bearer YOUR-API-KEY
tostringRecipient phone number, with country code recommended.
messagestringSMS text to send.
channelstringUse 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).
subjectstringRequired when channel=email. Ignored for SMS/WhatsApp.
smtp_server_idintOptional. SMTP server to send the email through; omit to auto-rotate across your configured servers.
scheduled_atstringOptional 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
}

Prezentare generală API

Aceasta este API-ul REST folosit de aplicația Android RCSZilla și panoul web pentru fluxuri de marketing SMS gratuit. Folosiți-l pentru a pune mesaje în coadă, a raporta starea livrării, a trimite răspunsuri primite și a sincroniza configurația dispozitivului.

Toate cererile și răspunsurile folosesc JSON. Toate endpoint-urile sunt servite de la https://api.rcszilla.com/ și sunt selectate prin parametrul ?endpoint=.

Format cerere

Fiecare cerere trebuie să trimită Content-Type: application/json și un antet de autorizare (cu excepția claim_device, care este public).

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

Format răspuns

Fiecare răspuns este un obiect JSON. Răspunsurile reușite conțin întotdeauna "success": true. Eșecurile conțin "success": false și un câmp "message".

JSONExemplu răspuns - success
{
  "success": true,
  "message": "Queued",
  "id": 123
}
JSONExemplu răspuns - error
{
  "success": false,
  "message": "id required"
}

Quick Reference

Endpoint Metodă Autentificare Descriere
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