RCSZilla Version 1.0

Documentation API Marketing SMS Gratuit

Guide d'intégration application mobile

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

Obtenez d'abord votre clé API

Avant d'envoyer des messages SMS gratuits, créez une clé API personnelle dans le panneau web. Cette clé permet à votre site, CRM ou outil d'automatisation d'appeler l'API directement.

  1. Connectez-vous au panneau web et allez dans Paramètres.
  2. Faites défiler jusqu'à la section Clé API et cliquez sur Générer une clé.
  3. Copiez la clé et utilisez-la dans l'en-tête Authorization: Bearer de vos requêtes.

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
}

Aperçu de l'API

Voici l'API REST utilisée par l'application Android RCSZilla et le panneau web pour les workflows de marketing SMS gratuit. Utilisez-la pour mettre des messages en file d'attente, signaler le statut de livraison, soumettre des réponses entrantes et synchroniser la configuration des appareils.

Toutes les requêtes et réponses utilisent JSON. Tous les endpoints sont servis depuis https://api.rcszilla.com/ et sont sélectionnés via le paramètre ?endpoint=.

Format de requête

Chaque requête doit envoyer Content-Type: application/json et un en-tête Authorization (sauf claim_device, qui est public).

HTTPExemple de requête
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 de réponse

Chaque réponse est un objet JSON. Les réponses réussies contiennent toujours "success": true. Les échecs contiennent "success": false et un champ "message".

JSONExemple de réponse - success
{
  "success": true,
  "message": "Queued",
  "id": 123
}
JSONExemple de réponse - error
{
  "success": false,
  "message": "id required"
}

Quick Reference

Endpoint Méthode Authentification Description
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