Crea una campagna

POST 
/api/partner-gateway/v1/campaigns

Crea una nuova campagna di messaggistica massiva. Il ciclo di vita tipico è: (1) Crea la campagna con readyToSend=false per salvarla come bozza. (2) Facoltativamente, aggiorna la campagna con PUT /campaigns/{id} per modificarne la configurazione. (3) Chiama POST /campaigns/{id}/calculateGoal per calcolare il numero di destinatari e il costo stimato. (4) Verifica il prezzo con GET /campaigns/{id}/price. (5) Imposta readyToSend=true tramite PUT /campaigns/{id} quando la configurazione è definitiva. (6) Conferma e invia la campagna con PUT /campaigns/{id}/confirm. Il canale è determinato dal campo sendingMode. I valori validi sono: SMS (messaggi di solo testo), RCS (messaggi rich card tramite un agente RCS), WHATSAPP (template WhatsApp pre-approvati) e modalità combinate come RCS_SMS, WHATSAPP_SMS, WHATSAPP_RCS, WHATSAPP_RCS_SMS, che forniscono il fallback automatico tra i canali. Per le campagne SMS devi fornire smsSender (l'ID mittente alfanumerico o il numero di telefono) e smsBody (il testo del messaggio, che supporta la sintassi {{placeholder}} per la personalizzazione con i campi del contatto). Per le campagne RCS devi fornire rcsAgentId e rcsTemplateId. Per le campagne WhatsApp devi fornire whatsappPhoneNumberId e whatsappTemplateId. I destinatari vengono specificati tramite contactListIds (un array di ID di liste contatti, destinationType=0), tramite destinations (un array di numeri di telefono in formato E.164, destinationType=1) oppure con entrambi (destinationType=2). Puoi impostare una scheduledDate futura (formato: yyyy-MM-dd HH:mm:ss.SSSZ) per programmare la campagna per un invio successivo anziché per l'invio immediato al momento della conferma. Restituisce 400 se mancano campi obbligatori o se sendingMode non è un valore valido. Restituisce 401 se la chiave API è mancante o non valida.

Richiesta

Risposte

201

Campagna creata con successo

400

Richiesta non valida

401

Non autorizzato