Creazione Campagna SMS

Crea e pianifica una nuova campagna SMS verso una lista di contatti.

POST /api/v1/{account_code}/campaigns/sms/create
Authorization Bearer {token}  — 56 caratteri

Questo endpoint permette di creare una campagna SMS schedulata verso una lista di contatti. È possibile specificare mittente, testo del messaggio, data di invio e un shortlink tracciato opzionale.

Invio pianificato Il parametro start definisce la data e l'ora di invio della campagna nel formato YYYY-MM-DD HH:MM. La campagna verrà accodata e inviata all'orario indicato.

Parametri (JSON)

Parametro Richiesto Tipo Descrizione
campaign_name SI string Nome identificativo della campagna (es: "Promo Febbraio 2026")
sender SI string Mittente alfanumerico registrato per il tuo account (es: "MYSHOP")
list_id SI integer ID della lista di contatti destinatari. Ottenibile tramite lists/get-all/
sms_text SI string Testo del messaggio SMS da inviare ai contatti della lista
start SI string Data e ora di invio pianificato. Formato: YYYY-MM-DD HH:MM (es: "2026-02-25 10:30")
shortlink1 NO string URL da includere nel testo come shortlink tracciato. Lasciare vuoto ("") se non necessario

Esempio Richiesta

JSON 
{
  "campaign_name": "Promo Febbraio 2026",
  "sender": "MYSHOP",
  "list_id": 123,
  "sms_text": "Ciao! Approfitta della nostra offerta esclusiva. Visita: {shortlink1}",
  "start": "2026-02-25 10:30",
  "shortlink1": "https://www.example.com/promo"
}

Risposta Successo

201 Created
JSON 
{
  "success": true,
  "message": "SMS Campaign created successfully.",
  "data": {
    "campaign_name": "Promo Febbraio 2026",
    "sender": "MYSHOP",
    "list_id": 123,
    "start": "2026-02-25 10:30:00",
    "created_at": "2026-02-24 09:15:00"
  }
}

Campi Risposta

Campo Tipo Descrizione
success boolean Risultato dell'operazione
message string Messaggio descrittivo
data.campaign_name string Nome della campagna
data.sender string Mittente impostato
data.list_id integer ID lista destinatari
data.start string Data/ora invio pianificato (formato: Y-m-d H:i:s)
data.created_at string Data/ora creazione campagna (formato: Y-m-d H:i:s)

Errori Comuni

400 Bad Request
JSON 
{
  "success": false,
  "message": "Necessary data is missing."
}
403 Forbidden — Token non valido
JSON 
{
  "success": false,
  "message": "NO Token Found."
}

Flusso Completo: Recupera Lista + Crea Campagna

1
Recupera l'ID della lista destinatari
Request 
GET /api/v1/{account_code}/lists/get-all/

// → Risposta: { "data": [ { "list_id": 123, "name": "Clienti 2026" } ] }
2
Crea la campagna usando il list_id
Request 
POST /api/v1/{account_code}/campaigns/sms/create

{
  "campaign_name": "Promo Febbraio 2026",
  "sender": "MYSHOP",
  "list_id": 123,
  "sms_text": "Ciao! La tua offerta esclusiva ti aspetta.",
  "start": "2026-02-25 10:30",
  "shortlink1": ""
}

// → Risposta: { "success": true, ... "data": {"campaign_name": "Promo Febbraio 2026", "sender": "MYSHOP", ...} }