![](\"https://smshosting.s3.eu-west-3.amazonaws.com/cover-progetto.jpg\")
\n\nGrazie alle REST API puoi integrare il tuo software con il nostro gateway in modo semplice e rapido.
\nLe REST API si basano sui metodi HTTP quindi per l'integrazione potrai utilizzare un Client HTTP scritto in un qualsiasi linguaggio di programmazione.
\nTramite le REST API sono possibili le seguenti operazioni:
\ninviare sms singoli e campagne
\ninviare campagne email
\ncercare e visualizzare il dettaglio degli sms inviati
\ncercare e visualizzare gli sms ricevuti con il servizio di ricezione
\nvisualizzare i dati relativi al proprio profilo su Smsosting.it
\ngestire i contatti ed i gruppi della rubrica
\ngestire le Fidelity Card
\ngestire i Coupon
\nSe non lo hai già fatto registrati a Smshosting.it in modo completamente gratuito.
\nL'indirizzo base da utilizzare per accedere alle REST API è il seguente
\nhttps://api.smshosting.it/rest/api
Per motivi di sicurezza le REST API utilizzano il solo protocollo HTTPS (il protocollo HTTP non è supportato).
\nTutte le richiesta alle REST API necessitano di essere autenticate attraverso il meccanismo della HTTP Basic authentication.
\nLo username e la password da fornire sono i codici AUTH_KEY e AUTH_SECRET associati al tuo profilo su Smshosting.it, visita la sezione gestione sicurezza API nella tua area privata per recuperali.
\nPuoi testare le tue credenziali chiamando semplicemente da browser il seguente URL:
\nhttps://AUTH_KEY:AUTH_SECRET@api.smshosting.it/rest/api/user
oppure eseguendo da shell Linux il comando
\ncurl --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user
Nel caso l'autenticazione non vada a buon fine viene restituito l'errore HTTP 401.
\nTutte le richieste alle REST API devono avere come encoding UTF-8.
\nLe richieste in HTTP POST e HTTP PUT devono avere come Content-Type nell'header application/x-www-form-urlencoded se non indicato diversamente.
Le REST API di Smshosting.it possono restituire le infomazioni sia nel formato JSON (default) che XML.
\nPer ottenere la risposta nel formato desiderato utilizza l'header HTTP \"Accept\" nella tua richiesta.
\ncurl -H \"Accept: application/json\" --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user
curl -H \"Accept: application/xml\" --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user
Desideriamo informarti che, al fine di garantire i più elevati standard di sicurezza, non supporteremo più i protocolli di crittografia di TLS 1.0 e TLS 1.1 a partire dal 31 Marzo 2023 consentendo l’accesso solo con i protocolli di versione TLS 1.2 o superiore.
\nPer qualsiasi supporto non esitare a contattaci all'indirizzo assistenza@smshosting.it oppure via telefono al 0437 30419.
\nPer ogni richiesta le REST API restituiscono uno dei seguenti HTTP Status Code:
\n200 - Richiesta completata correttamente
204 - Richiesta completata correttamente. Risorsa eliminata.
400 - Parametro mancante
401 - Autenticazione fallita
404 - Risorsa non trovata
405 - Metodo HTTP non consentito
500 - Errore imprevisto del server
Ad ogni chiamata HTTP GET e HTTP POST completata con successo (HTTP status uguale a 200) le REST API restituiscono come contenuto un JSON/XML.
\nIn caso di chiamata HTTP PUT e HTTP DELETE completata con successo (HTTP status uguale a 200 o 204) il contenuto della risposta sarà invece vuoto.
\nSe una chiamata dovesse terminare con un errore (HTTP status diverso da 200 o 204) viene resituito un JSON/XML esplicativo dell'errore avvenuto:
\nerrorCode - Codice HTTP status
errorMsg - Codice di errore esplicativo del problema occorso
Ad esempio nel caso l'autenticazione fallisca le REST API restituiscono un HTTP Status 401 e come contenuto:
\n{\n \"errorMsg\":\"BAD_CREDENTIALS\",\n \"errorCode\":401\n}\n\nAlcune risorse (ricerca sms inviati o ricevuti, ricerca contatti, etc.) restituiscono i risultati paginati.
\nAd esempio la ricerca sms inviati restituisce il seguente JSON
\n{\n \"metadata\":{\n \"count\":1,\n \"offset\":0,\n \"limit\":20\n },\n \"smsList\":[\n {\n \"id\":389395385,\n \"to\":\"393480000000\",\n \"text\":\"Test Sms\",\n \"from\":\"mrossi\",\n \"status\":\"DELIVERED\",\n \"insertDate\":\"2014-01-13T15:01:35+0100\",\n \"sentDate\":\"2014-01-13T15:01:37+0100\",\n \"deliveryDate\":\"2014-01-13T15:01:40+0100\",\n \"transactionId\":\"72810108d4114097b9edb42b255b273c\",\n \"price\":0.0945\n }\n ]\n}\n\nIl campo metadata contiene le informazioni utili a gestire la paginazione dei risultati.
La proprietà count indica il numero totale di risultati trovati per quella ricerca.
I campi offset e limit indicano rispettivamente l'indice del primo risultato ed il numero di risultati restituiti dalla chiamata.
offset e limit possono essere usati come parametri nella richiesta in modo da controllare il range di risultati restituiti.
Ad esempio se una ricerca trova 100 risultati e la dimensione della pagina è di 20 elementi
\n{\n \"metadata\":{\n \"count\":100,\n \"offset\":0,\n \"limit\":20\n },\n .......\n}\n\nsarà possibile ottenere 5 pagine usando i seguenti valori di offset e limit:
pagina 1 - offset=0&limit=20
pagina 2 - offset=20&limit=20
pagina 3 - offset=40&limit=20
pagina 4 - offset=60&limit=20
pagina 5 - offset=80&limit=20
Ti permette di integrare i nostri servizi nei tuoi progetti Java, aggiungendo la possibilità di inviare SMS, Email, gestire clienti e molto di più.
Vedi sorgenti
Integra nel tuo progetto PHP le funzionalità di Smshosting.
Vedi sorgenti
Libreria C# che ti permette di integrare Smshosting nei tuoi progetti: SMS, Email, gestire clienti e molto di più. Puoi trovarla su Github o NuGet
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Effettuare una richiesta","slug":"effettuare-una-richiesta"},{"content":"Deprecazione TLS 1.0 e 1.1","slug":"deprecazione-tls-10-e-11"},{"content":"Gestire la risposta","slug":"gestire-la-risposta"},{"content":"Librerie","slug":"librerie"}],"owner":"1793341","collectionId":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","publishedId":"TzRSiU1s","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-11T11:23:11.000Z"},"item":[{"name":"Invio SMS","item":[{"name":"Invio SMS","id":"2612f319-cc1f-486e-afa7-f434b2f536e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"from","value":"www.smshosting.it","description":"[String] (Opzionale)
\nIl mittente dell'SMS.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.
\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.
\nI mittenti non verificati verranno rimpiazzati con un mittente numerico casuale.
\n","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono (max 10 numeri) separandoli con il carattere virgola \",\".\nNel caso di più di 10 destinatari consigliamo di usare la chiamata di Invio SMS Bulk.
\nAd esempio:
\n393481234567 oppure 393481234567,393481234568,393481234568
Alternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).
\nAd esempio:
\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviare
\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:
1 oppure 1,2
\n","type":"text","disabled":true},{"key":"text","value":"sms di test","description":"[String] (Obbligatorio)
\nTesto del messaggio.\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.
\nAlcuni caratteri estesi occupano 2 caratteri. Nel caso di SMS che sforino la lunghezza standard di 160 caratteri solo a causa di alcuni caratteri estesi, questi saranno rimpiazzati con caratteri semplici mantendo il costo a 1 SMS invece che 2.
\nIl testo può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi ${nome proprietà}
\nNel caso il testo contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]\ntext=Invio sms di test a ${nome}
\n","type":"text"},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"[String] (Opzionale)
\nData (in formato yyyy-MM-ddTHH:mm:ssZ) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere Z indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).
\nAd esempio:\n2014-12-25T08:00:00+0200 indica il 25/12/2014 alle 08:00:00 riferito al GMT +2
\n","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Opzionale)
\nUn identificatore personale dell'invio.
\nConsente di assegnare a tutti gli sms inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. Massimo 60 caratteri.
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[String] (Opzionale)
\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.
\nPossibili valori true/false
\n","type":"text"},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Opzionale)
\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) dell'SMS.
\nVedi Gestione SMS Status Callback
\n","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:
\n7BIT - Encoding standard per i messaggi GSM. La lunghezza massima per un singolo sms è di 160 caratteri.
\nUCS2 - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di 70 caratteri.
\nAUTO - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.
\nDefault : 7BIT
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/send","description":"Invio di un sms ad uno o più destinatari singoli o verso uno o più gruppi della rubrica.
\nÈ possibile testare l'invio valorizzando il parametro sandbox a true nella richiesta.
Il parametro statusCallback consente di registrare un URL al quale sarà inviata via HTTP una notifica con lo stato (Consegnato, Non Consegnato, ecc...) dell'SMS.
![](\"https://smshosting.s3.eu-west-3.amazonaws.com/warning_it.png\")
\n\n\n\nPoni particolare attenzione al fatto che l'id dell'SMS potrebbe essere un intero a 64 bit (int64)
\n
Controlla che la tua piattaforma sia in grado di gestirlo!
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Opzionale)
\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio
\nPer i dettagli vedi Send Bulk Callback
\n","type":"text","disabled":true},{"key":"from","value":"www.SmsH.it","description":"Vedi Invio SMS
\n","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"Vedi Invio SMS
\n","type":"text"},{"key":"group","value":"gruppo","description":"Vedi Invio SMS
\n","type":"text","disabled":true},{"key":"text","value":"sms di test","description":"Vedi Invio SMS
\n","type":"text"},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"Vedi Invio SMS
\n","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"Vedi Invio SMS
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"Vedi Invio SMS
\n","type":"text"},{"key":"statusCallback","value":"http://user_callback","description":"Vedi Invio SMS
\n","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"Vedi Invio SMS
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/sendbulk","description":"Modalità di invio sms asincrono da utilizzare con un numero elevato di destinatari (Più di 10 destinatari per singola richiesta).
\nUna volta inviata la richiesta viene restituito un transactionId utile a identificare sucessivamente gli sms.
\nNel caso l'invio non possa essere completato a causa di un errore verrà inviata un'email contentente il codice di errore.
\nNota****__: Se invii fino a 10 destinatari per singola richiesta ti consigliamo di utilizzare la funzione di Invio SMS
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Obbligatorio)
\nContenuto binario del messaggio espresso come stringa esadecimale.\nOgni byte deve essere rappresentato con un valore esadecimale di due caratteri.
\nAd esempio:\n0fc24abf3413ba
[String] (Opzionale)\nCampo facoltativo contenente l'UDH (User Data Header) del messaggio in formato esadecimale.\nAd esempio:\n00c34abf300311
[Number] (Opzionale)\nCampo facoltativo contenente l'id protocollo (Protocol identifier) da utilizzare in formato decimale.
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/sendbinary","description":"Invio di un SMS con contenuto binario.
\nNote sulle lunghezza del messaggio:
\nLa lunghezza massima di un singolo SMS binario è di 140 byte (280 caratteri espressi in formato esadecimale).
\nSpecificando un testo più lungo verranno inviati SMS concatenati. Lo spazio a disposizione per gli SMS concatenati è di 134 byte per SMS (268 caratteri espressi in formato esadecimale)
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
I dati di invio ritornati sono gli stessi della chiamata Vedi Invio SMS.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","sms","sendbinary"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"dbc873df-2448-4885-8001-ecc291c5f7bd","name":"Invio SMS Binario","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"text","value":"sms di test","description":"[String] *(Obbligatorio)*\n\nContenuto binario del messaggio espresso come stringa esadecimale.\nOgni byte deve essere rappresentato con un valore esadecimale di due caratteri.\n\nAd esempio:\n`0fc24abf3413ba`","type":"text"},{"key":"udh","value":"","description":"[String] *(Opzionale)*\nCampo facoltativo contenente l'UDH ([User Data Header](https://en.wikipedia.org/wiki/User_Data_Header)) del messaggio in formato esadecimale.\nAd esempio:\n`00c34abf300311`","type":"text","disabled":true},{"key":"transactionCallback","value":"","description":"Vedi [Invio SMS](#descrizione-invio-sms)\n\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio\n[Gestione notificationCallback](#sms-status-callback)","type":"text","disabled":true},{"key":"pid","value":"","description":"[Number] *(Opzionale)*\nCampo facoltativo contenente l'id protocollo ([Protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier)) da utilizzare in formato decimale.","type":"text","disabled":true},{"key":"from","value":"www.SmsH.it","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text"},{"key":"group","value":"gruppo","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text"},{"key":"statusCallback","value":"http://user_callback","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/sendbulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"from\":\"mrossi\",\n \"text\":\"0fc24abf3413ba\",\n \"transactionId\":\"e51ea840fc7276922ac61b733027301d\"\n}"}],"_postman_id":"a2db0ec6-3808-4a72-ae2a-5bcd526f6ad2"},{"name":"Cerca SMS","id":"3aa145d2-7d1a-475f-90c5-89331b57e026","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/sms/search?id&transactionId=123456789ABCDE&msisdn&fromDate&toDate&status&offset=0&limit=20","description":"Cerca tra gli SMS inviati.
\nValorizzare almeno uno tra i seguenti parametri:
\n[String] (Opzionale)
\nId interno del messaggio inviato.
\nÈ possibile specificare più id separandoli con il carattere virgola \",\". (Massimo 2000 id).
\nAd esempio:
\n12312 oppure 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"[String] (Opzionale)
\ntransactionId assegnato all'invio.
\n","type":"text/plain"},"key":"transactionId","value":"123456789ABCDE"},{"description":{"content":"[String] (Opzionale)
\nNumero al quale è stato inviato il messaggio
\n","type":"text/plain"},"key":"msisdn","value":null},{"description":{"content":"[String] (Opzionale)
\nCerca gli sms stati inviati da questa data (formato yyyy-MM-ddTHH:mm:ssZ)
\nIl carattere Z indica il timezone nel formato RFC822 4-digit. \nPer l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno.
\n","type":"text/plain"},"key":"fromDate","value":null},{"description":{"content":"[String] (Opzionale)
\nCerca gli sms stati inviati fino a questa data (formato yyyy-MM-ddTHH:mm:ssZ)
\n","type":"text/plain"},"key":"toDate","value":null},{"description":{"content":"[String] (Opzionale)
\nStato degli sms [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)
\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:\nSe la ricerca trova 100 sms, il campo offset viene valorizzato a 50 ed il campo limit a 10 verranno restituiti gli sms da 51 a 60.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Opzionale)
\nNumero di risultati che verranno restituiti.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"1d01659a-1eb9-4073-98d5-efff65dc2c92","name":"Cerca SMS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/sms/search?id&transactionId=123456789ABCDE&msisdn&fromDate&toDate&status&offset=0&limit=20","host":["{{BaseUrl}}"],"path":["rest","api","sms","search"],"query":[{"key":"id","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**12312** oppure **432432,543543,435435**"},{"key":"transactionId","value":"123456789ABCDE","description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\n**transactionId** assegnato all'invio."},{"key":"msisdn","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero al quale è stato inviato il messaggio"},{"key":"fromDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati da questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)\n\nIl carattere **Z** indica il timezone nel formato RFC822 4-digit. _Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno_."},{"key":"toDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati fino a questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)"},{"key":"status","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nStato degli sms [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)"},{"key":"offset","value":"0","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\nSe la ricerca trova 100 sms, il campo **offset** viene valorizzato a 50 ed il campo **limit** a 10 verranno restituiti gli sms da 51 a 60.\n**Default : 0**"},{"key":"limit","value":"20","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero di risultati che verranno restituiti.\n**Default: 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"smsList\": [\n {\n \"id\": 389395385,\n \"to\": \"393480000000\",\n \"text\": \"Test Sms\",\n \"from\": \"mrossi\",\n \"status\": \"DELIVERED\",\n \"insertDate\": \"2014-01-13T15:01:35+0100\",\n \"sentDate\": \"2014-01-13T15:01:37+0100\",\n \"deliveryDate\": \"2014-01-13T15:01:40+0100\",\n \"transactionId\": \"72810108d4114097b9edb42b255b273c\",\n \"price\": 0.0945\n }\n ]\n}"}],"_postman_id":"3aa145d2-7d1a-475f-90c5-89331b57e026"},{"name":"Annulla Invio SMS","id":"ecd0f78b-ebc9-4c5a-b155-2b0fadbe8198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","description":"[Number] (Opzionale) -> valorizzare almeno uno tra i parametri id o transactionId
id interno del messaggio inviato.
È possibile specificare più id separandoli con il carattere virgola \",\".
\nAd esempio:\n12312 oppure 432432,543543,435435
\n","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Opzionale) -> valorizzare almeno uno tra i parametri id o transactionId
transactionId assegnato all'invio
Annulla l'invio di un SMS non ancora inviato (invio differito).
\nLa chiamata ritorna la lista degli sms annullati.
\nPer il dettaglio delle proprietà di ogni singolo sms vedi la Descrizione Risposta della funzione Cerca Sms.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","sms","cancel"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0b60699e-c64a-4bb6-bef3-ebb17d1060c9","name":"Annulla Invio SMS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","description":"[Number] *(Opzionale ¹)*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**12312** oppure **432432,543543,435435**","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] *(Opzionale ¹)*\n\n**transactionId** assegnato all'invio","type":"text"}]},"url":"{{BaseUrl}}/rest/api/sms/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 389451366,\n \"to\": \"393480000000\",\n \"text\": \"Test Sms\",\n \"from\": \"mrossi\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2014-01-16T13:46:11+0100\",\n \"transactionId\": \"1389876345449\",\n \"price\": 0\n }\n]"}],"_postman_id":"ecd0f78b-ebc9-4c5a-b155-2b0fadbe8198"},{"name":"Preventivo Invio SMS","id":"69cdea48-f85b-448a-bbd7-d94b4147f9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"from","value":"www.smshosting.it","description":"[String] Opzionale
\nIl mittente dell'SMS.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.
\n","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"[String] Opzionale (valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.
\nÈ possibile specificare più numeri di telefono (max 1000 numeri) separandoli con il carattere virgola \",\".
\nAd esempio:\n393481234567 oppure 393481234567,393481234568,393481234568
[String] Opzionale (valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviarel'SMS. \nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:\n1 oppure 1,2
[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:
\nDefault : 7BIT
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/estimate","description":"Calcolo del credito necessario per un invio SMS (singolo o invio multiplo).
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Con queste chiamate puoi effettuare e gestire invii SMS singoli o massivi
\nI possibili stati di un sms (campo status) sono:
\n","_postman_id":"397a271c-6a60-4e67-a692-d4d016da08d1","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Invio SMS OTP (2FA)","item":[{"name":"Invio Codice OTP (2FA)","id":"5bd4b854-d636-418a-b0e7-abaf6b97797a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"393480000000","description":"[String] (Obbligatorio)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.
\nAd esempio:\n393481234567
\n","type":"text"},{"key":"text","value":"your code: ${verify_code}","description":"[String] (Obbligatorio)
\nTesto del messaggio.
\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.
\nIl testo deve contenere il placeholder che sarà sostituito in fase di invio dal codice OTP.
\nIl placeholder va specificato con la sintassi ${verify_code}
\nAd esempio:
\ntext=Ecco il tuo codice ${verify_code}
\n","type":"text"},{"key":"from","value":"www.SmsH.it","description":"[String] (Opzionale)
\nIl mittente dell'SMS.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di 11 caratteri. Se non specificato verrà usato il mittente di default del proprio profilo.
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[String] (Opzionale)
\nConsente di fare la chiamata senza inviare effettivamente il messaggio.
\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.
\nPossibili valori true/false
\n","type":"text"},{"key":"app_id","value":"myappid","description":"[String] (Opzionale)
\nIdentifica l'applicazione per cui si richiede il codice.
\nÈ possibile specificare un proprio identificativo
\nAttenzione: Non si possono generare 2 codici attivi contemporaneamente per lo stesso destinatario per la stessa applicazione.
\n","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.
\nI possibili valori sono:
\nDefault : 7BIT
\n","type":"text","disabled":true},{"key":"code_len","value":"5","description":"[String] (Opzionale)
\nLunghezza del codice OTP
\nI valori possibili sono da 4 a 6.
\nDefault: 4
\n","type":"text","disabled":true},{"key":"max_retry","value":"5","description":"[String] (Opzionale)
\nNumero massimo di tentativi ammessi.
\nI valori possibili sono da 1 a 20.
\nDefault: 3
\n","type":"text","disabled":true},{"key":"ttl","value":"300","description":"[String] (Opzionale)
\nValidità in secondi del codice.
\nIl valore minimo è di 10.
\nDefault: 300
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/verify/send","description":"Invia un codice numerico OTP (One Time Password ad un destinatario. Adatto per l'implementazione di 2FA (2 Factor Authentication)
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Verifica un codice OTP inviato via SMS.
\n[String] (Obbligatorio)
\nIl codice verify_id ricevuto nella risposta del comando send.
\n","type":"text/plain"},"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97"},{"description":{"content":"[String] (Obbligatorio)
\nIl codice OTP da verificare.
\n","type":"text/plain"},"key":"verify_code","value":"1234"},{"disabled":true,"description":{"content":"[String) (Opzionale)
\nVerrà salvato l'indirizzo IP recuperabile assieme agli altri dati della verifica del codice tramite la chiamata Ricerca Codice
\n","type":"text/plain"},"key":"ip_address","value":"192.168.0.1"}],"variable":[]}},"response":[{"id":"55807e2a-e77e-4348-be6b-d61940a6fed5","name":"Verifica Codice","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/verify/check?verify_id=334ecb42ebda471a02adfa044b546e94c2059c97&verify_code=1234","host":["{{BaseUrl}}"],"path":["rest","api","verify","check"],"query":[{"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97","description":"[String] *(Obbligatorio)*\n\nIl codice **verify_id** ricevuto nella risposta del comando send.\n"},{"key":"verify_code","value":"1234","description":"[String] *(Obbligatorio)*\n\nIl codice OTP da verificare."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id_sms\": \"410065822\",\n \"verify_status\": \"VERIFIED\"\n}"}],"_postman_id":"70be54df-1e0c-466d-966d-6d806425dc64"},{"name":"Annulla Codice","id":"d3f80b99-2485-4a36-a75d-6e5299a5b9bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97","description":"[String] (Obbligatorio)
\nIl codice verify_id ricevuto nella risposta del comando send.
\n","type":"text"},{"key":"command","value":"DELETE","description":"[String] (Obbligatorio)
\nPuò assumenre il valore:\nDELETE
Annulla un codice OTP attivo e ancora utilizzabile.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Recupera i dettagli di un codice OTP.
\n[String] (Obbligatorio)
\nIl codice verify_id ricevuto nella risposta del comando send.
\n","type":"text/plain"},"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97"}],"variable":[]}},"response":[{"id":"a5d21a1e-32be-4cfc-bbcd-a1bf6506433b","name":"Ricerca Codice","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/verify/search?verify_id=334ecb42ebda471a02adfa044b546e94c2059c97","host":["{{BaseUrl}}"],"path":["rest","api","verify","search"],"query":[{"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"verify_id\": \"334ecb42ebda471a02adfa044b546e94c2059c97\",\n \"verify_status\": \"VERIFIED\",\n \"to\": \"393480000000\",\n \"from\": \"393480000000\",\n \"id_sms\": \"410065825\",\n \"date_submit\": 1480499821000,\n \"valid_until\": 1480500121000,\n \"checks\": [\n {\n \"date\": 1480499858000,\n \"verify_code\": \"4506\",\n \"verify_status\": \"VERIFIED\",\n \"ip_address\": \"192.168.1.1\"\n }\n ]\n}"}],"_postman_id":"9b96f0c1-e1f7-4651-aff8-ad51e0500d83"}],"id":"b96741e6-af33-4287-a759-4bcf6ded7462","description":"Con queste chiamate sarai in grado di inviare semplicemente codici OTP senza doverti occupare della logica di invio/validazione:
\n${verify_code}Ritorna la lista degli alias configurati.
\n[String] (Obbligatorio)
\nStringa identificativa dell'alias.
\nLa stringa non può superare gli 11 caratteri.
\nPuò contenere solo lettere (a-z) maiuscole o minuscole, numeri, spazi ed i caratteri . _ - & @ * ''
\n","type":"text"},{"key":"businessname","value":"ACME Company","description":"[String] (Obbligatorio)
\nRagione sociale dell'azienda da associare all'alias
\n","type":"text"},{"key":"address","value":"via Roma, 1","description":"[String] (Obbligatorio)
\nIndirizzo della sede dell'azienda da associare all'alias
\n","type":"text"},{"key":"city","value":"Belluno","description":"[String] (Obbligatorio)
\nCittà della sede dell'azienda da associare all'alias
\n","type":"text"},{"key":"postcode","value":"32100","description":"[String] (Obbligatorio)
\nCAP della sede dell'azienda da associare all'alias
\n","type":"text"},{"key":"province","value":"BL","description":"[String] (Obbligatorio)
\nProvincia della sede dell'azienda da associare all'alias (sigla di due lettere)
\n","type":"text"},{"key":"country","value":"IT","description":"[String] (Obbligatorio)
\nNazione della sede dell'azienda da associare all'alias.
\nSpecificare il codice ISO 3166-1 a due lettere.
\nAd esempio per l'italia specificare IT
\n","type":"text"},{"key":"vatnumber","value":"01010101251","description":"[String] (Obbligatorio)
\nPartita IVA dell'azienda da associare all'alias
\n","type":"text"},{"key":"email","value":"info@acme.company","description":"[String] (Obbligatorio)
\nIndirizzo email dell'azienda da associare all'alias
\n","type":"text"},{"key":"contact","value":"3480000000","description":"[String] (Obbligatorio)
\nNumero di telefono, fax e orari di apertura dell'azienda da associare all'alias
\n","type":"text"},{"key":"taxcode","value":"01010101251","description":"[String] (Obbligatorio)
\nCodice fiscale dell'azienda da associare all'alias
\n","type":"text"},{"key":"pec","value":"acmecompany@acmepec.it","description":"[String] (Obbligatorio)
\nPosta elettronica certificata (PEC) da associare all'alias, per le aziende non residenti in Italia, inserire un indirizzo email
\n","type":"text"},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Opzionale)
\nURL al quale sarà inviata via HTTP/HTTPS una notifica in POST con lo stato (VERIFIED, NOTVERIFIED) dell'alias\n.\nI parametri passati alla chiamata sono id, alias e status e il Content Type utilizzato è application/x-www-form-urlencoded
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/alias/","description":"Crea un nuovo Alias: per poter utilizzare un mittente personalizzato per l'invio di SMS è obbligatorio creare un nuovo alias via API o via interfaccia web.\nLa creazione di un nuovo Alias tramite API prevede l'accettazione della seguente clausola:\n\"Dichiaro che i dati sopra indicati sono conformi alle delibere AGCOM n. 42/13/CIR, 50/14/CIR, 18/17/CIR, 306/20/CIR e successive tempo per tempo emanate e si riferiscono all'utilizzatore dell'Alias; acconsento inoltre che i dati forniti per la registrazione sia pubblicabili e soggetti a processi di individuazione del reale soggetto origine della messaggistica.\"
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Cancella in modo definitivo un Alias.
\n[Number] (Obbligatorio)
\nIdentificativo interno dell'alias da eliminare
\n","type":"text/plain"},"type":"any","value":"123","key":"aliasId"}]}},"response":[{"id":"34cf2bdc-4689-4c9e-b4f0-09ef31fd2505","name":"Delete Alias","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/alias/:aliasId","host":["{{BaseUrl}}"],"path":["rest","api","alias",":aliasId"],"variable":[{"key":"aliasId","value":"123","description":"[Number] *(Obbligatorio)*\n\nIdentificativo interno dell'alias da eliminare"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4fc463bf-d1ca-47cb-97ec-55989afe3031"}],"id":"cc625a64-6e92-48dc-b948-0370988adb0f","description":"Gli alias sono i mittenti alfanumerici (di massimo 11 caratteri) utilizzabili per l'invio degli SMS.
\n","_postman_id":"cc625a64-6e92-48dc-b948-0370988adb0f","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Ricezione SMS","item":[{"name":"Cerca SMS Ricevuti","id":"0d6929d9-5bb7-44fc-aff1-e09d1eaf7363","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/sms/received/search?from=393480000000&simIdRef=&fromDate=&toDate","description":"Ricerca degli sms ricevuti con il servizio di ricezione.
\nValorizzare almeno uno tra i seguenti parametri:
\nfromsimIdReffromDatetoDate[String] (Opzionale)
\nMittente degli sms ricevuti.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono separandoli con il carattere virgola \",\".
\nAd esempio:
\n393481234567 oppure 393481234567,393481234568,393481234568
\n","type":"text/plain"},"key":"from","value":"393480000000"},{"description":{"content":"[Number] (Opzionale)
\nIdentificativo del servizio di ricezione sui quali sono stati ricevuti gli sms
\n","type":"text/plain"},"key":"simIdRef","value":""},{"description":{"content":"[String] (Opzionale)
\nSms ricevuti \"da data\" in formato yyyy-MM-ddTHH:mm:ssZ\nIl carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito. Vedi paginazione.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti. Vedi paginazione.
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"[String] (Opzionale)
\nSms ricevuti \"fino a data\" in formato yyyy-MM-ddTHH:mm:ssZ Il carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
\n","type":"text/plain"},"key":"toDate","value":null}],"variable":[]}},"response":[{"id":"4aeaa16f-8346-4272-9222-8868eca42c94","name":"Cerca SMS Ricevuti","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/sms/received/search?from=393480000000&simIdRef=&fromDate=&toDate","host":["{{BaseUrl}}"],"path":["rest","api","sms","received","search"],"query":[{"key":"from","value":"393480000000","description":"[String] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nMittente degli sms ricevuti.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare _più numeri di telefono_ separandoli con il carattere virgola \",\".\n\nAd esempio:\n\n**393481234567** oppure **393481234567,393481234568,393481234568**"},{"key":"simIdRef","value":"","description":"[Number] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nIdentificativo del servizio di ricezione sui quali sono stati ricevuti gli sms"},{"key":"fromDate","value":"","description":"[String] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nData dalla quale gli sms sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)"},{"key":"toDate","value":null,"description":"[String] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nData fino alla quale gli sms sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)"},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito. Vedi [paginazione](#gestire-la-risposta).","disabled":true},{"key":"limit","value":"20","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti. Vedi [paginazione](#gestire-la-risposta).","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 20\n },\n \"smsList\": [\n {\n \"from\": \"+393450000000\",\n \"text\": \"Test sms 1\",\n \"receiveDate\": \"2011-04-21T13:23:13+0200\"\n },\n {\n \"from\": \"+393480000000\",\n \"text\": \"Test sms 1\",\n \"receiveDate\": \"2011-01-18T11:42:51+0100\"\n }\n ]\n}"}],"_postman_id":"0d6929d9-5bb7-44fc-aff1-e09d1eaf7363"},{"name":"Lista dei Servizi di Ricezione","id":"aeabb47c-8990-4bd8-b142-4d17fa447932","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/sms/received/sim/list","description":"Ritorna l'elenco dei servizi di ricezione acquistati.
\nCon queste chiamate API potrai interagire con il servizio di ricezione \"Forward SMS\".
\n","_postman_id":"f875835a-7600-45e3-b823-2ceb799c84ad","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Ricezione RCS","item":[{"name":"Cerca RCS Ricevuti","id":"d2254654-245f-4488-bfb8-05a3b796e6c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/rcs/message/received/search?agentId=1","description":"Ricerca degli rcs ricevuti con il servizio di ricezione.
\nValorizzare almeno uno tra i seguenti parametri:
\nfromsimIdReffromDatetoDate[String] (Opzionale)
\nMittente degli rcs ricevuti.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.
\nÈ possibile specificare più numeri di telefono separandoli con il carattere virgola \",\".
\nAd esempio:\n393481234567 oppure 393481234567,393481234568,393481234568
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"[Number] (Opzionale)
\nIdentificativo dell'agent
\n","type":"text/plain"},"key":"agentId","value":"1"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData dalla quale gli rcs sono stati ricevuti in formato yyyy-MM-ddTHH:mm:ssZ
\nIl carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData fino alla quale gli rcs sono stati ricevuti in formato yyyy-MM-ddTHH:mm:ssZ
\nIl carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
\n","type":"text/plain"},"key":"toDate","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\ntransactionId assegnato all'invio.
\n","type":"text/plain"},"key":"transactionId","value":""},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito. Vedi paginazione.
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nNumero massimo di risultati che verranno restituiti. Vedi paginazione.
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"e1cc3dac-a2f1-489b-b5d3-b5824f3548ba","name":"Cerca RCS Ricevuti","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/rcs/message/received/search?agentId=1","host":["{{BaseUrl}}"],"path":["rest","api","rcs","message","received","search"],"query":[{"key":"from","value":"","description":"[String] _(Opzionale)_\n\nMittente degli rcs ricevuti.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\n\nÈ possibile specificare _più numeri di telefono_ separandoli con il carattere virgola \",\".\n\nAd esempio:\n**393481234567** oppure **393481234567,393481234568,393481234568**","disabled":true},{"key":"agentId","value":"1","description":"[Number] _(Opzionale)_\n\nIdentificativo dell'agent"},{"key":"fromDate","value":"","description":"[String] _(Opzionale)_\n\nData dalla quale gli rcs sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\n\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)","type":"text","disabled":true},{"key":"toDate","value":"","description":"[String] _(Opzionale)_\n\nData fino alla quale gli rcs sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\n\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)","type":"text","disabled":true},{"key":"transactionId","value":"","description":"[String] *(Opzionale)*\n\n**transactionId** assegnato all'invio.","type":"text","disabled":true},{"key":"offset","value":"","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito. Vedi [paginazione](#gestire-la-risposta).","type":"text","disabled":true},{"key":"limit","value":"","description":"[Number] *(Opzionale)*\nNumero massimo di risultati che verranno restituiti. Vedi [paginazione](#gestire-la-risposta).","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"rcsList\": [\n {\n \"agentId\": \"1\",\n \"from\": \"3400000000\",\n \"text\": \"{\\n \\\"agentId\\\": \\\"AGENT_ID\\\",\\n \\\"senderPhoneNumber\\\": \\\"PHONE_NUMBER\\\",\\n \\\"messageId\\\": \\\"MESSAGE_ID\\\",\\n \\\"sendTime\\\": \\\"2018-12-31T15:01:23.045123456Z\\\",\\n \\\"text\\\": \\\"Hello, world!\\\"\\n}\",\n \"receiveDate\": \"2022-07-07T18:14:26+0200\"\n }\n ]\n}"}],"_postman_id":"d2254654-245f-4488-bfb8-05a3b796e6c8"}],"id":"9b5bde4f-eebf-4013-9f37-543073148b6e","description":"Con queste chiamate API potrai interagire con il servizio di ricezione RCS.
\n","_postman_id":"9b5bde4f-eebf-4013-9f37-543073148b6e","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Invio Email","item":[{"name":"Lista Mittenti","id":"0abb68af-b33c-4bf2-8add-a90c78a368aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/sender/list","description":"Restituisce la lista dei mittenti configurati dall'utente tramite interfaccia web.
\nVisualizza la lista di tutti i modelli email creati dall'utente tramite interfaccia web.
\nLa risposta contiene un JSON contenente una lista di template , ognuno con le seguenti proprietà:
[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:
\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituiti i coupon da 51 a 60.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti nella ricerca.
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"d89958c9-b1fd-4465-a4ff-659b3e836426","name":"Lista Modelli","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/email/template/list?offset=0&limit=5","host":["{{BaseUrl}}"],"path":["rest","api","email","template","list"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 20\n },\n \"templates\": [\n {\n \"id\": 2038,\n \"title\": \"Modello Uno\",\n \"editorType\": \"B\",\n \"contentType\": \"multipart/alternative\",\n \"insertDate\": \"2020-06-30T13:48:27+0200\",\n \"updateDate\": \"2020-06-30T14:33:33+0200\",\n \"customFieldsKey\": [\n \"f_s_nome\"\n ]\n },\n {\n \"id\": 299,\n \"title\": \"test\",\n \"editorType\": \"B\",\n \"contentType\": \"multipart/alternative\",\n \"insertDate\": \"2020-04-10T12:27:37+0200\",\n \"updateDate\": \"2020-04-10T12:27:50+0200\"\n }\n ]\n}"}],"_postman_id":"4b8bca1b-e264-4c85-9404-20d9f1d2613c"},{"name":"Dettaglio Modello","id":"2ab81ecf-bcd0-4c2b-9179-c2a86ba148b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/template/:templateId","description":"Restituisce il dettaglio di un singolo modello email. Il dettaglio contiene anche il campo customFieldsKey che contiene l'id dei campi dinamici da compilare all'interno del template.
Restituisce la lista delle campagne email inviate.
\nLa risposta è un JSON contenente una lista di campaignList , ognuna contenente le seguenti proprietà:
[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:
\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituiti i coupon da 51 a 60.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti nella ricerca.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"7d5816b4-31e2-4050-8817-2511032c7bd0","name":"Lista Campagne Email","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/email/campaign/list?offset=0&limit=5","host":["{{BaseUrl}}"],"path":["rest","api","email","campaign","list"],"query":[{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a 50 e il campo **limit** a 10 verranno restituiti i coupon **da 51 a 60**.\n\n**Default: 0**"},{"key":"limit","value":"5","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 5\n },\n \"campaignList\": [\n {\n \"id\": 2385,\n \"campaignTitle\": \"Invio Orange Friday\",\n \"templateId\": 2038,\n \"from\": \"mr.brown@fake.it\",\n \"fromName\": \"Orange Friday\",\n \"subject\": \"Why only black? Get the orange\",\n \"subjectPreviewText\": \"Orange Friday 2020\",\n \"enableOpenTracking\": true,\n \"enableLinkTracking\": true,\n \"stats\": {\n \"countEmailInserted\": 1,\n \"countEmailStatusPending\": 0,\n \"countEmailStatusNoSent\": 0,\n \"countEmailTotSent\": 1,\n \"countEmailStatusBounced\": 0,\n \"countEmailOpenedUnique\": 1,\n \"countEmailClickUnique\": 0,\n \"countEmailStatusSpamReport\": 0,\n \"countEmailCauseUnsubscribed\": 0\n }\n },\n {\n \"id\": 2570,\n \"campaignTitle\": \"Invio Blue Monday\",\n \"templateId\": 2385,\n \"from\": \"mr.brown@fake.it\",\n \"fromName\": \"Mr. Brown\",\n \"subject\": \"Why only black? Get the blue\",\n \"subjectPreviewText\": \"Get the blue today!\",\n \"enableOpenTracking\": false,\n \"enableLinkTracking\": false,\n \"stats\": {\n \"countEmailInserted\": 9,\n \"countEmailStatusPending\": 0,\n \"countEmailStatusNoSent\": 0,\n \"countEmailTotSent\": 9,\n \"countEmailStatusBounced\": 0,\n \"countEmailOpenedUnique\": 0,\n \"countEmailClickUnique\": 0,\n \"countEmailStatusSpamReport\": 0,\n \"countEmailCauseUnsubscribed\": 0\n }\n }\n ]\n}"}],"_postman_id":"20368c02-146f-47e2-8803-302095030f49"},{"name":"Dettaglio Campagna Email","id":"3eac6e40-d45d-479f-a97a-5194ae33930e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/campaign/:campaignId","description":"Restituisce il dettaglio con i dati e le statistiche di una singola campagna email.
\n[String] (Obbligatorio)
\nid della campagna email di cui si vuole recuperare il dettaglio
Restituisce tutte le email inviate con una campagna
\n[String] (Opzionale)\nStato dell'email:
\nNOSENT - Email non inviataBOUNCED - Email non consegnataSPAMREPORT - Email segnalata come SPAMOPENED - Email apertaCLICKED - Email cliccataUNSUBSCRIBED - Effettuata disiscrizione da parte del destinatario[String] (Opzionale)
\nIndirizzo email del destinatario
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nId interno dell'email inviata.\nÈ possibile specificare più id separandoli con il carattere virgola \",\". (Massimo 2000 id).\nAd esempio:\n12312 oppure 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nPosizione del primo risultato che verrà restituito.\nEsempio:\nSe la ricerca trova 100 email, il campo offset viene valorizzato a 50 ed il campo limit a 10 verranno restituiti le email da 51 a 60.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nNumero di risultati che verranno restituiti.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[{"description":{"content":"[String] (Obbligatorio)\nid della campagna con cui sono state inviate le email
Restituisce il dettaglio di una singola email inviata.
\nid del messaggio email di cui si vogliono recuperare i dettagli
[Number] (Obbligatorio)
\nid del template da utilizzare per l'invio, può essere recuperato da interfaccia web dalla pagina di dettaglio del modello. Per vedere il dettaglio clicca: Email -> Modelli -> Modifica Modello -> \"Identificativo interno\"
[String] (Obbligatorio)
\nIndirizzo email del mittente dell'invio, deve essere un mittente verificato da interfaccia web
\n","type":"text"},{"key":"fromName","value":"Orange Friday","description":"[String] (Obbligatorio)
\nNome che comparirà al destinatario come mittente dell'email
\n","type":"text"},{"key":"group","value":"103838","description":"[Number] (Obbligatorio)
\nid del gruppo a cui inviare l'email, recuperabile da interfaccia web o tramite la chiamata Gruppi Rubrica -> Lista Gruppi
[String] (Obbligatorio)
\nOggetto dell'email
\n","type":"text"},{"key":"campaignTitle","value":"Invio Orange Friday","description":"[String] (Opzionale)
\nTitolo della campagna email
\n","type":"text"},{"key":"subjectPreviewText","value":"Orange Friday 2020","description":"[String] (Opzionale)
\nAnteprima del testo dell'email (questo testo è visualizzato solo in alcuni client di posta)
\n","type":"text"},{"key":"enableOpenTracking","value":"false","description":"[Boolean] (Opzionale)
\nSe impostato a false disabilita il tracciamento per l'apertura dell'email
Default: true
\n","type":"text","disabled":true},{"key":"enableLinkTracking","value":"false","description":"[Boolean] (Opzionale)
\nSe impostato a false disabilita il tracciamento per i click sui link presenti nell'email
Default: true
\n","type":"text","disabled":true},{"key":"date\n","value":"2029-01-01T00:00:01%2B0200","description":"[String] (Opzionale)
\nInvia la campagna alla data e ora specificate nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[Boolean] (Opzionale)
\nSe impostato a true simula l'invio senza inviare realmente le email
Default: false
\n","type":"text"},{"key":"replyTo","value":"replytoAddress@fake.it","description":"[String] (Opzionale)\nIndirizzo reply to dell' email
\n","type":"text","disabled":true},{"key":"replyToName","value":"replyToName","description":"[String] (Opzionale)\nNome associato all' indirizzo reply to dell' email
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/email/campaign/send","description":"Permette di inviare una campagna email ad un gruppo di contatti della rubrica.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del template da utilizzare per l'invio, può essere recuperato da interfaccia web dalla pagina di dettaglio del modello. Per vedere il dettaglio clicca: Email -> Modelli -> Modifica Modello -> \"Identificativo interno\"
[String] (Obbligatorio)
\nIndirizzo email del mittente dell'invio, deve essere un mittente verificato da interfaccia web
\n","type":"text"},{"key":"fromName","value":"Mr. Brown","description":"[String] (Obbligatorio)
\nNome che comparirà al destinatario come mittente dell'email
\n","type":"text"},{"key":"to","value":"[{'to':'ms.green@fake.it','f_s_nome':'Clara'},{'to':'mr.yellow@fake.it','f_s_nome':'John'}]","description":"[String] (Obbligatorio)
\nDestinatario della mail in uno dei seguenti formati:
\nms.green@fake.it[{'to':'ms.green@fake.it','f_s_nome':'Ms Green'},{'to':'mr.yellow@fake.it','f_s_nome':'John Yellow'}][String] (Obbligatorio)
\nOggetto dell'email
\n","type":"text"},{"key":"subjectPreviewText","value":"preview","description":"[String] (Opzionale)\nAnteprima del testo dell'email (questo testo è visualizzato solo in alcuni client di posta)
\n","type":"text"},{"key":"enableOpenTracking","value":"false","description":"[Boolean] (Opzionale)
\nSe impostato a false disabilita il tracciamento per l'apertura dell'email
Default: true
\n","type":"text","disabled":true},{"key":"enableLinkTracking","value":"false","description":"[Boolean] (Opzionale)
\nSe impostato a false disabilita il tracciamento per i click sui link presenti nell'email
Default: true
\n","type":"text","disabled":true},{"key":"date","value":"2029-01-01T00:00:01%2B0200","description":"[String] (Opzionale)
\nInvia la campagna alla data e ora specificate nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[Boolean] (Opzionale)
\nSe impostato a true simula l'invio senza inviare realmente le email\nDefault: false
[String] (Opzionale)
\nIndirizzo reply to dell' email
\n","type":"text","disabled":true},{"key":"replyToName","value":"replyToName","description":"[String] (Opzionale)
\nNome associato all' indirizzo reply to dell' email
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/email/send","description":"Permette di inviare una singola email ad un massimo di 50 destinatari anche non inseriti in un gruppo della rubrica.
\n\n\n\n\nPoni particolare attenzione al fatto che l'id dell'Email potrebbe essere un intero a 64 bit (int64)
\n
Controlla che la tua piattaforma sia in grado di gestirlo!
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Queste API ti permettono di gestire in maniera automatica le tue campagne email.
\n\n\nL'invio email è una funzionalità del Piano Premium. Attiva gratis il tuo periodo di prova.
\n
\n\n","_postman_id":"9b6a15a8-5779-4c21-bcc0-610672142e19","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Fidelity Card","item":[{"name":"Fidelity List","id":"fe3ac333-e324-4eb6-8e1b-181ae02a9403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/list","description":"Per poter utilizzare le Email API è necessario richiedere la specifica abilitazione.\nRichiedila qui
\n
Restituisce la lista dei programmi Fidelity dell'utente.
\nRitorna la lista paginata di tutte le Fidelity Card associate al programma Fidelity.
\n[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti nella ricerca.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:
\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituite le fidelity card da 51 a 60.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData di emissione della Fidelity Card nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2019-11-22T11:22:33%2B0200"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData di emissione della Fidelity Card nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2019-11-23T11:22:33%2B0200"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nId del contatto a cui è associata la fidelity
\n","type":"text/plain"},"key":"idContact","value":"123"}],"variable":[{"description":{"content":"[Number (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"1ad016cd-a96c-42b5-b089-c7e5e9cadeae","name":"Fidelity Card List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/list","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card","list"],"query":[{"key":"limit","value":"5","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**","disabled":true},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a 50 e il campo **limit** a 10 verranno restituite le fidelity card **da 51 a 60**.\n\n**Default: 0**","disabled":true},{"key":"fromDate","value":"2019-11-22T11:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData di emissione della Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2019-11-23T11:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData di emissione della Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**\n","disabled":true},{"key":null,"value":null,"disabled":true}],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"limit\": 3\n },\n \"fidelityCardList\": [\n {\n \"fidelityId\": 123,\n \"fidelityCardId\": 2668,\n \"fidelityCode\": \"CARD_00011\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 21\n },\n {\n \"fidelityId\": 123,\n \"fidelityCardId\": 2669,\n \"fidelityCode\": \"CARD_00014\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 0\n },\n {\n \"fidelityId\": 123,\n \"fidelityCardId\": 2670,\n \"fidelityCode\": \"CARD_00021\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 0\n }\n ]\n}"}],"_postman_id":"3c330a27-7f87-4ad4-b538-65db5e7d2e78"},{"name":"Fidelity Card Add","id":"b5a01176-861a-41dd-8322-acaad9d7cc18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"msisdn","value":"393400000000","description":"[String] (Obbligatorio)
\nNumero di cellulare del contatto compreso di prefisso internazionale.
\nEs. 393400000000
\n","type":"text"},{"key":"cardCode","value":"CARD0001","description":"[String] (Opzionale)
\nCodice della Fidelity Card da 6 a 30 caratteri 0-9A-Za-z_.
\nSe assente ne verrà generato uno di 15 caratteri in automatico.
\n","type":"text"},{"key":"startingPoints","value":"3","description":"[Number] (Opzionale)
\nPunti caricati sulla Fidelity Card al momento della creazione.
\n","type":"text","disabled":true},{"key":"startingAmount","value":"7.15","description":"[Decimal] (Opzionale)
\nImporto speso associato alla Fidelity Card al momento della creazione.
\n","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] (Opzionale)
\nDefault: true manda un sms al contatto con uno short url che permette di aggiungere la Fidelity Card al wallet dello smartphone (Google Pay o Apple Wallet).
Se valorizzato a false non manda l'sms al contatto.
Aggiunge una Fidelity Card al Programma Fidelity e la aggiunge al contatto.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"898b6f7a-682b-42ec-bb47-58603fda1c00","name":"Fidelity Card Add","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"msisdn","value":"393400000000","description":"[String] *(Obbligatorio)*\n\nNumero di cellulare del contatto compreso di prefisso internazionale.\n\nEs. **393400000000**","type":"text"},{"key":"cardCode","value":"CARD0001","description":"[String] *(Opzionale)*\n\nCodice della Fidelity Card da **6** a **30** caratteri **0-9A-Za-z_**.\n\nSe assente ne verrà generato uno di **15** caratteri in automatico.","type":"text"},{"key":"startingPoints","value":"3","description":"[Number] *(Opzionale)*\n\nPunti caricati sulla Fidelity Card al momento della creazione.","type":"text","disabled":true},{"key":"startingAmount","value":"7.15","description":"[Decimal] *(Opzionale)*\n\nImporto speso associato alla Fidelity Card al momento della creazione.","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] *(Opzionale)*\n\nDefault: `true` manda un sms al contatto con uno short url che permette di aggiungere la Fidelity Card al wallet dello smartphone (Google Pay o Apple Wallet).\n\nSe valorizzato a `false` non manda l'sms al contatto.\n","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card"],"variable":[{"key":"id","value":"123","description":"[Number *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"fidelityId\": 38,\n \"fidelityCardId\": 1234,\n \"fidelityCode\": \"F582323963717\",\n \"activationDate\": \"2019-12-03T14:26:48+0100\",\n \"active\": true,\n \"points\": 0\n}"}],"_postman_id":"b5a01176-861a-41dd-8322-acaad9d7cc18"},{"name":"Fidelity Card Detail","id":"d04c58f8-c017-48db-baad-509f57c6aca9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode","description":"Ritorna il dettaglio di una Fidelity Card.
\n[Number] (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Obbligatorio)
\nCodice della Fidelity Card
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"}]}},"response":[{"id":"6b97a842-e92c-4db7-903b-b9e2ac77fa1c","name":"Fidelity Card Detail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card",":fidelityCode"],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"},{"key":"fidelityCode","value":"CARD0001","description":"[String] *(Obbligatorio)*\n\nCodice della *Fidelity Card*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"fidelityId\": 123,\n \"fidelityCardId\": 12345,\n \"fidelityName\": \"Programma fidelity supercool\",\n \"contactDetail\": {\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"email\": \"mario.rossi@fake.it\",\n \"groups\": [\n {\n \"id\": 10001,\n \"name\": \"amici\"\n }\n ],\n \"customFields\": [\n {\n \"fieldKey\": \"f_s_msisdn\",\n \"fieldName\": \"Cellulare\",\n \"fieldValue\": \"393480000000\"\n },\n {\n \"fieldKey\": \"f_s_email\",\n \"fieldName\": \"Email\",\n \"fieldValue\": \"mario.rossi@fake.it\"\n },\n {\n \"fieldKey\": \"f_s_nome\",\n \"fieldName\": \"Nome\",\n \"fieldValue\": \"Mario\"\n },\n {\n \"fieldKey\": \"f_s_cognome\",\n \"fieldName\": \"Cognome\",\n \"fieldValue\": \"Rossi\"\n }\n ]\n },\n \"fidelityCode\": \"CARD0001\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 7\n}"}],"_postman_id":"d04c58f8-c017-48db-baad-509f57c6aca9"},{"name":"Fidelity Card Records","id":"0274a13f-9eb9-4d5c-8272-5cb73dc06877","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record/list","description":"Ritorna la lista paginata di tutti i punti/premi assegnati alla Fidelity Card.
\n[String] (Opzionale)
\nFiltra il tipo di operazione effettuata sulla fidelity, i possibili valori sono:
\nADD - Punti aggiunti alla Fidelity CardREWARD - Premi assegnato alla Fidelity CardAZZERA - Azzeramento puntiIMPORT - Punti aggiunti all'import bulk della Fidelity CardCREATE - Punti aggiunti alla creazione della Fidelity CardPLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti nella ricerca.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:
\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituiti i record da 51 a 60.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"10"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData dell'operazione sulla Fidelity Card nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2019-11-27T15:38:09%2B0100"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData dell'operazione sulla Fidelity Card nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2019-11-22T11:22:33%2B0200"}],"variable":[{"description":{"content":"[Number] (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Obbligatorio)
\nCodice della Fidelity Card
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"}]}},"response":[{"id":"d6f8f0b0-eba2-4b2e-95a0-7281174a4465","name":"Fidelity Card Records","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record/list","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card",":fidelityCode","record","list"],"query":[{"key":"action","value":"ADD","description":"[String] *(Opzionale)*\n\nFiltra il tipo di operazione effettuata sulla fidelity, i possibili valori sono:\n\n* `ADD` - Punti aggiunti alla Fidelity Card\n* `REWARD` - Premi assegnato alla Fidelity Card\n* `AZZERA` - Azzeramento punti\n* `IMPORT` - Punti aggiunti all'import bulk della Fidelity Card\n* `CREATE` - Punti aggiunti alla creazione della Fidelity Card\n* `PLAN_NOT_ENABLED` - Questa chiamata non è permessa nel piano utente","disabled":true},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**","disabled":true},{"key":"offset","value":"10","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a **50** e il campo limit a **10** verranno restituiti i record **da 51 a 60**.\n\n**Default: 0**","disabled":true},{"key":"fromDate","value":"2019-11-27T15:38:09%2B0100","description":"[String] *(Opzionale)*\n\nData dell'operazione sulla Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2019-11-22T11:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData dell'operazione sulla Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true}],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"},{"key":"fidelityCode","value":"CARD0001","description":"[String] *(Obbligatorio)*\n\nCodice della *Fidelity Card*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"158"},{"key":"Date","value":"Tue, 11 May 2021 10:52:09 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"fidelityCardRecordList\": [\n {\n \"id\": 123456,\n \"points\": 2,\n \"amount\": 5.38,\n \"action\": \"ADD\",\n \"date\": \"2021-05-11T12:52:02+0200\"\n }\n ]\n}"}],"_postman_id":"0274a13f-9eb9-4d5c-8272-5cb73dc06877"},{"name":"Fidelity Card Record Retrieve","id":"f55a3ca6-c587-4cd8-b1e0-7029d529e7a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record/:recordId","description":"Recupera le informazioni di un record di movimento punti su una Fidelity Card
\n[Number] (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Obbligatorio)
\nCodice della Fidelity Card
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"},{"description":{"content":"[Number] (Obbligatorio)
\nid del record da recuperare, ottenibile dopo la chiamata Fidelity Card Record Add o Fidelity Card Records
Elimina un record di movimento punti da una Fidelity Card.
\n[Number] (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Obbligatorio)
\nCodice della Fidelity Card
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"},{"description":{"content":"[Number] (Obbligatorio)
\nid del record da eliminare, ottenibile con la chiamata Fidelity Card Record Add o Fidelity Card Records
[String] (Obbligatorio)
\nTipo di operazione effettuata sulla Fidelity Card, i possibili valori sono:
\nADD - Aggiunta punti/importo alla Fidelity CardREWARD - Premi assegnato alla Fidelity CardAZZERA - Azzeramento punti[Number] (Opzionale) -> valorizzare uno tra i parametri points o amount per la action ADD
Punti assegnati alla Fidelity Card.
\nSe questo parametro non viene valorizzato, verranno aggiunti i punti alla fidelity in base all'amount ed il valore del singolo punto (punti = amount / valore_singolo_punto).
\n","type":"text"},{"key":"amount","value":"5.38","description":"[Decimal] (Opzionale) -> valorizzare uno tra i parametri points o amount per la action ADD
Importo speso.
\nSe questo parametro non viene valorizzato, verrano aggiunti i punti specificati nel parametro points.
[Number] (Opzionale) -> parametro obbligatorio per la action REWARD
Identificativo del premio da assegnare alla Fidelity Card.
\n","type":"text","disabled":true},{"key":"note","value":"My notes","description":"[String] (Opzionale)
\nCampo generico per delle note associate all'operazione.
\n","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] (Opzionale)
\nDefault: true se il contatto ha raggiunto i punti per riscattare un premio, viene inviato in automatico un sms.
Se valorizzato a false non manda l'sms al contatto.
Modifica il punteggio di una Fidelity Card. Al momento sono supportati i seguenti movimenti:
\nADD - Aggiunge puntiREWARD - Assegna un premioAZZERA - Azzera il punteggio della carta\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del programma Fidelity recuperato con la chiamata Fidelity List
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Obbligatorio)
\nCodice della Fidelity Card
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"}]}},"response":[{"id":"c10118fc-050e-47f9-b7a6-650214af755e","name":"Fidelity Card Record Add","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action","value":"ADD","description":"[String] *(Obbligatorio)*\n\nTipo di operazione effettuata sulla Fidelity Card, i possibili valori sono:\n* `ADD` - Aggiunta punti/importo alla Fidelity Card\n* `REWARD` - Premi assegnato alla Fidelity Card\n* `AZZERA` - Azzeramento punti","type":"text"},{"key":"points","value":"2","description":"[Number] *(Opzionale)*\n\nPunti assegnati alla Fidelity Card.\n\nSe questo parametro non viene valorizzato, verranno aggiunti i punti alla fidelity a seconda dell'amount (**amount = punti * valore_singolo_punto**).\n\n_**Nota**: almeno uno tra i parametri `points` o `importo` sono obbligatori per la action `ADD`._","type":"text"},{"key":"amount","value":"5.38","description":"[Decimal] *(Opzionale)*\n\nImporto speso con con l'operazione di assegnazione punti.\n\nSe questo parametro non viene valorizzato, verrano aggiunti i punti alla fidelity in rapporto all'importo speso (**punti = amount / valore_singolo_punto**).\n\n_**Nota**: almeno uno tra i parametri `points` o `importo` sono obbligatori per la action `ADD`._","type":"text"},{"key":"rewardId","value":"11","description":"[Number] *(Opzionale)*\n\nIdentificativo del premio da assegnare alla Fidelity Card.\n\n_**Nota**: parametro obbligatorio per la action `REWARD`._","type":"text","disabled":true},{"key":"note","value":"My notes","description":"[String] *(Opzionale)*\n\nCampo generico per delle note associate all'operazione.","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] *(Opzionale)*\n\nDefault: `true` se il contatto ha raggiunto i punti per riscattare un premio, viene inviato in automatico un sms.\n\nSe valorizzato a `false` non manda l'sms al contatto.","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card",":fidelityCode","record"],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"},{"key":"fidelityCode","value":"CARD0001","description":"[String] *(Obbligatorio)*\n\nCodice della *Fidelity Card*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"points\": 2,\n \"amount\": 11.12,\n \"action\": \"ADD\",\n \"date\": \"2020-07-06T12:53:41+0200\"\n}"}],"_postman_id":"8ec0b09a-d419-4845-9023-f54150c43b3a"}],"id":"d02f738b-8c1a-49c6-80c1-d0df9d01437e","description":"Gestione completa delle fidelity card via REST API.
\n\n\n","_postman_id":"d02f738b-8c1a-49c6-80c1-d0df9d01437e","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Coupon Digitali","item":[{"name":"Coupon Campaign List","id":"e6beda10-7383-4b45-9227-19b86c772c5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/digitalcoupon/campaign/list","description":"Le Fidelity Card sono una funzionalità del Piano Premium. Attiva gratis il tuo periodo di prova.
\n
Restituisce la lista delle Campagne Coupon dell'utente.
\nRitorna il dettaglio di una Campagna Coupon.
\n[Number] (Obbligatorio)
\nid della campagna coupon
[String] (Obbligatorio)
\nNome della Campagna Coupon (es. Coupon Black Friday)
[String] (Obbligatorio)\n F o D Coupon Fisso o Dinamico
[String] (Opzionale)
\nCodice del Coupon se di tipo Fisso F (es. MYCOUPON_F_12345)
[String] (Opzionale)
\nData di inizio validità della Campagna Coupon nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"endDate","value":"2020-07-18T19:22:33+0200","description":"[String] (Opzionale)
\nData di fine validità della Campagna Coupon nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/digitalcoupon/campaign","description":"Crea una nuova Campagna Coupon.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Restituisce la lista dei programmi Fidelity dell'utente.
\nCerca un coupon
\n[Number] (Opzionale)
\nid della Campagna Coupon
[String] (Opzionale)
\n codice del coupon
[Number] (Opzionale)\nid del contatto
[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti nella ricerca.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:
\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituiti i coupon da 51 a 60.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[String] (Opzionale)\nCreazione del coupon \"da data\" nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2020-06-18T19:22:33%2B0200"},{"disabled":true,"description":{"content":"[String] (Opzionale)\nCreazione del coupon \"fino a data\" nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2020-11-22T11:22:33%2B0200"},{"disabled":true,"description":{"content":"[String] (Opzionale)\ntrue per ottenere solo i coupon utilizzabili (non scaduti, non già usati, ecc)
\n","type":"text/plain"},"key":"onlyUsable","value":"true"}],"variable":[]}},"response":[{"id":"49414611-c416-4fe7-a903-375b9cd40404","name":"Coupon Search","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/search?campaignId=138","host":["{{BaseUrl}}"],"path":["rest","api","digitalcoupon","coupon","search"],"query":[{"key":"campaignId","value":"138","description":"[Number] *(Opzionale)*\n\n`id` della Campagna Coupon\n"},{"key":"couponCode","value":"3VWYF1OTIEYN","description":"[String] *(Opzionale)*\n\n `codice` del coupon","disabled":true},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**","disabled":true},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a 50 e il campo **limit** a 10 verranno restituiti i coupon **da 51 a 60**.\n\n**Default: 0**","disabled":true},{"key":"fromDate","value":"2020-06-18T19:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData di creazione del coupon nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2020-11-22T11:22:33%2B0200","description":"[String] *(Opzionale)*\nData di creazione del coupon nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 11,\n \"offset\": 0,\n \"limit\": 2\n },\n \"couponList\": [\n {\n \"code\": \"vwtthwrh\",\n \"insertDate\": \"2020-06-30T08:54:33+0200\",\n \"campaignId\": 38\n },\n {\n \"code\": \"1NBNFME8PR\",\n \"insertDate\": \"2020-06-29T14:31:14+0200\",\n \"campaignId\": 38\n }\n ]\n}"}],"_postman_id":"3aa9e0e6-69bc-4b80-96e2-e7e785136829"},{"name":"Coupon Detail","id":"02c68e42-f45d-474a-a20a-c9bfe4a2667e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/:couponCode","description":"Restituisce il dettaglio di un Coupon
\n[String] (Obbligatorio)
\nCodice del coupon di cui si vogliono recuperare i dettagli
\n","type":"text/plain"},"type":"any","value":"MYCOUPON123","key":"couponCode"}]}},"response":[{"id":"2ac3af06-bb42-4f18-8b6c-0a3dd3b17fff","name":"Coupon Detail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/:couponCode","host":["{{BaseUrl}}"],"path":["rest","api","digitalcoupon","coupon",":couponCode"],"variable":[{"key":"couponCode","value":"MYCOUPON123","description":"[String] *(Obbligatorio)*\n\nCodice del coupon di cui si vogliono recuperare i dettagli"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MYCOUPON123\",\n \"insertDate\": \"2026-01-10T16:20:02+0100\",\n \"campaignId\": 38,\n \"usages\": 5,\n \"couponType\": \"D\",\n \"isUsable\": true,\n \"dstList\": [\n {\n \"idcoupon\": 8475684,\n \"idsms\": 9871425,\n \"idcontatto\": 102,\n \"msisdn\": \"393000000000\",\n \"insertDate\": \"2026-01-10T16:20:02+0100\"\n }\n ]\n}"}],"_postman_id":"02c68e42-f45d-474a-a20a-c9bfe4a2667e"},{"name":"Generate Coupon","id":"154870d4-cb6b-4477-b533-fb6274565639","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"campaignId","value":"138","description":"[Number] (Obbligatorio)
\nid della campagna coupon a cui aggiungere il coupon
[String] (Opzionale)
\nCodice del Coupon se di tipo Dinamico (compreso tra 6 e 32 caratteri). Se non fornito verrà generato un Codice Coupon casuale fornito nella risposta.
\n","disabled":true},{"key":"couponLength","value":"10","description":"[Number] (Opzionale)
\nLughezza del Codice Coupon casuale generato automaticamente
\nDefault: 6
\n","type":"text","disabled":true},{"key":"contactId","value":"123","description":"[Number] (Opzionale)\nId contatto a cui associare il coupon generato
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/digitalcoupon/coupon","description":"Genera un nuovo Coupon in una campagna di tipo D (coupon Dinamico).
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Obbligatorio)
\nCodice del coupon che si vuole segnalare come utilizzato.
\n","type":"text/plain"},"type":"any","value":"MYCOUPON_2020","key":"couponCode"}]}},"response":[{"id":"fe182518-4bf7-4549-9a88-a3278c4f8392","name":"Coupon Usage","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/:couponCode/usage","host":["{{BaseUrl}}"],"path":["rest","api","digitalcoupon","coupon",":couponCode","usage"],"variable":[{"key":"couponCode","value":"MYCOUPON_2020","description":"[String] *(Obbligatorio)*\n\nCodice del coupon che si vuole segnalare come utilizzato."}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MYCOUPON_2020\",\n \"insertDate\": \"2020-06-29T12:51:53+0200\",\n \"campaignId\": 38,\n \"usages\": 10\n}"}],"_postman_id":"cb0d1897-18bb-435c-af74-4aaabba7cb00"}],"id":"7a9cb2be-069a-4fd1-b5ff-2b2b56425470","description":"Gestione completa di Coupon Digitali via REST API.
\n\n\n","_postman_id":"7a9cb2be-069a-4fd1-b5ff-2b2b56425470","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Booking","item":[{"name":"Calendar List","id":"120db30c-e7dd-48e8-b897-f75910fdfcec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/booking/calendar","description":"I Coupon Digitali sono una funzionalità del Piano Premium. Attiva gratis il tuo periodo di prova.
\n
Restituisce la lista di tutti i calendari configurati dall'utente.
\nRestituisce il dettaglio di un calendario.
\n[Number] (Obbligatorio)
\nid del calendario di cui si vuole recuperare il dettaglio, vedi chiamata Calendar List
Restituisce la lista dei servizi (task) associati al calendario.
\n[Number] (Obbligatorio)
\nid del calendario di cui si vogliono recuperare le attività (task), vedi chiamata Calendar List
Restituisce la lista delle prenotazioni (reservation) associate al calendario.
\n[Number] (Obbligatorio)
\nid del calendario di cui si vuole recuperare l'attività (task), vedi chiamata Calendar List
[Number] (Obbligatorio)
\nid del servizio (task) di cui si vuole recuperare il dettaglio, vedi chiamata Task List
Restituisce la lista degli orari con gli slot prenotabili per la giornata specificata.\nL'orario è restituito nel formato HH:mm
[Number] (Obbligatorio)
\nid del calendario da cui si vogliono recuperare le prenotazioni, vedi chiamata Calendar List
[Number] (Obbligatorio)
\nid del servizio (task) di cui si vuole recuperare la lista degli slot liberi, vedi chiamata Task List
Restituisce la lista delle prenotazioni (reservation) associate al calendario.
\n[Number] (Opzionale)
\nFiltra solo appuntamento per questo id task
[String] (Opzionale)
\nFiltra per stato della prenotazione, i possibili valori sono:
\nCONFIRMED - Mostra solo prenotazioni confermateUNCONFIRMED - Mostra solo prenotazioni non ancora confermateDELETED - Mostra solo prenotazioni eliminate[String] (Opzionale)
\nFiltra in base alla data di inizio della prenotazione nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2021-03-27T15:38:09%2B0100"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nFiltra in base alla data di inizio della prenotazione nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2021-02-27T15:38:09%2B0100"},{"description":{"content":"[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti nella ricerca.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"[Number] (Opzionale)\nPosizione del primo risultato che verrà restituito.\nEsempio:\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituite le fidelity card da 51 a 60.\nDefault: 0
\nEsempio:
\nSe il campo offset viene valorizzato a 50 e il campo limit a 10 verranno restituite le fidelity card da 51 a 60.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nCerca prenotazioni che contengono la stringa nel nome e cognome del contatto
\n","type":"text/plain"},"key":"query","value":"Mario"}],"variable":[{"description":{"content":"[Number] (Obbligatorio)
\nid del calendario da cui si vogliono recuperare le prenotazioni, vedi chiamata Calendar List
Restituisce la lista delle prenotazioni (reservation) associate al calendario.
\n[Number] (Obbligatorio)
\nid del calendario da cui si vogliono recuperare le prenotazioni, vedi chiamata Calendar List
[Number] (Obbligatorio)
\nid della prenotazione di cui si vuole recuperare il dettaglio
[Number] (Obbligatorio)
\nid del servizio (task) al quale si vuole aggiungere una prenotazione
[Number] (Obbligatorio)
\nid del contatto a cui si vuole associare la prenotazione
[String] (Obbligatorio)
\nData e ora di inizio della prenotazione nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text"},{"key":"status","value":"CONFIRMED","description":"[String] (Opzionale)
\nStato della nuova prenotazione, i possibili valori sono:CONFIRMED - prenotazione confermataUNCONFIRMED - prenotazione da confermare
Nota: se non viene specificato lo status la prenotazione viene inserita con la policy specificata da interfaccia web [CONFIRMED|UNCONFIRMED]
[String] (Opzionale)
\nNote associate alla prenotazione
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/booking/calendar/:calendarId/reservation","description":"Aggiunge una Prenotazione al Calendario specificato.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del calendario a cui si vuole aggiungere la prenotazione, vedi chiamata Calendar List
[Number] (Opzionale)
\nid del contatto a cui si vuole associare la prenotazione
[String] (Opzionale)
\nData e ora di inizio della prenotazione nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"status","value":"CONFIRMED","description":"[String] (Opzionale)
\nStato della prenotazione, i possibili valori sono:CONFIRMED - prenotazione confermataUNCONFIRMED - prenotazione da confermareDELETED - prenotazione eliminata
Nota: se non viene specificato lo status la prenotazione viene inserita con la policy specificata da interfaccia web [CONFIRMED|UNCONFIRMED]
[String] (Opzionale)
\nNote associate alla prenotazione
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/booking/calendar/:calendarId/reservation/:reservationId","description":"Modifica una Prenotazione nel Calendario specificato.
\nE' possibile modificare solo prenotazioni non ancora scadute né eliminate.
\nUna prenotazione confermata (CONFIRMED) può solo essere rifiutata (REFUSED) o eliminata (DELETED).
Se rifiutata verrà inviato un messaggio di notifica al contatto (come configurato da pannello web), se eliminata non verrà inviata nessuna notifica al contatto
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del calendario a cui si vuole aggiungere la prenotazione, vedi chiamata Calendar List
[Number] (Obbligatorio)
\nid della prenotazione che si desidera modificare
Elimina una Prenotazione dal Calendario specificato.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del calendario a cui appartiene la prenotazione da eliminare, vedi chiamata Calendar List
[Number] (Obbligatorio)
\nid della prenotazione che si desidera eliminare
Cerca un contatto in rubrica.
\n[String] (Opzionale)
\nNome completo del contatto.
\nLa ricerca viene effettuata sui campi name e lastname
[String] (Opzionale)
\nNumero di cellulare del contatto.
\nIl numero di cellulare deve essere comprensivo del prefisso internazionale es. 393480000000
\n","type":"text/plain"},"key":"msisdn","value":"393480000000"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nIndirizzo email del contatto
\n","type":"text/plain"},"key":"email","value":"test@test.it"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nRicerca per campo specifico.
\nInserire la chiave relativa al campo che si vuole utilizzare per la ricerca.
\nLe chiavi dei campi personalizzati si possono recuperare con la chiamata Lista Campi
\n","type":"text/plain"},"key":"fieldKey","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nRicerca per campo specifico.
\nInserire il valore che si vuole trovare, la ricerca verrà effettuata all'interno del campo specificato nel parametro fieldKey .
[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito. Vedi paginazione.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti. Vedi paginazione.
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"[String] (Opzionale)\nCampo con cui si desidera ordinare i risultati:
\nname - Campo nomelastname - Campo cognome[String] (Opzionale)\nModalità in cui vengono ordinati i contatti:
\nASC - Ordine A-ZDESC - Ordine Z-ARitorna il dettaglio di un contatto inserito in rubrica.
\n[Number] (Obbligatorio)
\nIdentificativo univoco del contatto
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"92e10995-ee47-4323-bd8c-916519ca5330","name":"Dettaglio Contatto","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId"],"variable":[{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123456789,\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"email\": \"mario.rossi@fake.it\",\n \"groups\": [\n {\n \"id\": 13197,\n \"name\": \"Friends\"\n },\n {\n \"id\": 1947,\n \"name\": \"Business\"\n }\n ],\n \"customFields\": [\n {\n \"fieldKey\": \"f_indirizzo\",\n \"fieldName\": \"Indirizzo\",\n \"fieldValue\": \"via roma 1\"\n },\n {\n \"fieldKey\": \"f_cap\",\n \"fieldName\": \"CAP\",\n \"fieldValue\": \"30000\"\n }\n ]\n}"}],"_postman_id":"5c4a31ef-56c2-4f99-be97-719279df2482"},{"name":"Nuovo Contatto","id":"2f489dc2-d2d4-45f1-bd5d-bec41e4458d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customFieldUniqueKey","value":"msisdn","description":"[String] (Obbligatorio)
\nE' la chiave che serve a determinare quale campo identifica univocamente il contatto. Se non specificato è il numero di telefono (msisdn).
Possbili valori: msisdn, email, name, lastname, f_*
[String] (Opzionale)
\nNumero di cellulare del contatto.
\nIl numero di cellulare deve essere comprensivo del prefisso internazionale es. 393480000000
\n","type":"text"},{"key":"name","value":"Mario","description":"[String] (Obbligatorio)
\nNome del contatto (max 20 caratteri)
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] (Opzionale)
\nCognome del contatto (max 20 caratteri)
\n","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] (Opzionale)
\nIndirizzo email
\n","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] (Opzionale)
\nId inteno della lista contatti in cui inserire il contatto.
\nÈ possibile specificare più liste separandole con il carattere virgola \",\".
\nAd esempio:
\n1245 oppure 1245,3432
[String] (Opzionale)
\nChiave/valore del campo pesonalizzato che si vuole popolare
\nL'elenco delle chiavi disponibili, da usare come nome parametro, può essere recuperato con la chiamata Lista Campi Personalizzati
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact","description":"Aggiunge un contatto in rubrica
\n\n\nIl \"Content-Type\" per le richieste POST deve essere \"application/x-www-form-urlencoded\"
\n
Vedi la chiamata dettaglio contatto
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","phonebook","contact"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d639cb4f-a8ff-4cfc-a044-4b6b27595fff","name":"Nuovo Contatto","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customFieldUniqueKey","value":"msisdn","description":"[String] *(Obbligatorio)*\n\nE' la chiave che serve a determinare quale campo identifica univocamente il contatto. Se non specificato è il numero di telefono (`msisdn`).\n\nPossbili valori: `msisdn`, `email`, `name`, `lastname`, `f_*`","type":"text"},{"key":"msisdn","value":"393480000000","description":"[String] *(Opzionale)*\n\nNumero di cellulare del contatto.\n\nIl numero di cellulare deve essere comprensivo del prefisso internazionale es. **393480000000**","type":"text"},{"key":"name","value":"Mario","description":"[String] *(Obbligatorio)*\n\nNome del contatto (**max 20 caratteri**)","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] *(Opzionale)*\n\nCognome del contatto (**max 20 caratteri**)","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] *(Opzionale)*\n\nIndirizzo email","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] *(Opzionale)*\n\nId inteno della lista contatti in cui inserire il contatto.\n\nÈ possibile specificare più liste separandole con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**`1245`** oppure **`1245,3432`**","type":"text","disabled":true},{"key":"${fieldKey}","value":"","description":"[String] *(Opzionale)*\n\nChiave/valore del campo pesonalizzato che si vuole popolare\n\nL'elenco delle chiavi disponibili, da usare come **nome parametro**, può essere recuperato con la chiamata [Lista Campi Personalizzati](#dettaglio-lista-campi-personalizzati)","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123456789,\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"customFields\": [\n {\n \"fieldKey\": \"f_indirizzo\",\n \"fieldName\": \"Indirizzo\",\n \"fieldValue\": \"via roma 1\"\n }\n ]\n}"}],"_postman_id":"2f489dc2-d2d4-45f1-bd5d-bec41e4458d1"},{"name":"Carica Contatti Bulk","id":"2defe360-a21e-4661-bcec-d39bcdea6421","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/home/plolrt/Desktop/TMP/esempio_rubrica.csv"}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact/addContactBulk","description":"Caricamento massivo contatti
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"multipart/form-data\"
\n
In caso di caricamento massivo, mostra lo stato di avanzamento.
\n[String] (Opzionale)
\nVedi Nuovo Contatto
\n","type":"text","disabled":true},{"key":"msisdn","value":"393480000000","description":"[String] (Opzionale)
\nVedi Nuovo Contatto
\n","type":"text"},{"key":"name","value":"Mario","description":"[String] (Opzionale )
\nVedi Nuovo Contatto
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] (Opzionale)
\nVedi Nuovo Contatto
\n","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] (Opzionale)
\nVedi Nuovo Contatto
\n","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] (Opzionale)
\nVedi Nuovo Contatto
\n","type":"text","disabled":true},{"key":"${fieldKey}","value":"","description":"[String] (Opzionale)
\nVedi Nuovo Contatto
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","description":"Modifica un contatto già presente in rubrica.
\n\n\nIl \"Content-Type\" per le richieste POST deve essere \"application/x-www-form-urlencoded\"
\n
E' obbligatorio valorizzare almeno un parametro nel body della chiamata.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","phonebook","contact",":contactId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Number] (Obbligatorio)
\nIdentificativo univoco del contatto
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"be7e7622-8c68-49e6-bc4a-f7ac257174be","name":"Aggiorna Contatto","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customFieldUniqueKey","value":"msisdn","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"msisdn","value":"393480000000","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text"},{"key":"name","value":"Mario","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"${fieldKey}","value":"","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:37:01 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b1850077-8c61-4e13-9cba-5bf8340988d9"},{"name":"Elimina Contatto","id":"16bf7e82-f64f-4473-81c1-a84dbd12e35f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","description":"Elimina un contatto presente in rubrica
\n[Number] (Obbligatorio)
\nIdentificativo univoco del contatto
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"81c2573d-8d0a-4339-807f-e99c5b84548c","name":"Elimina Contatto","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:38:41 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"16bf7e82-f64f-4473-81c1-a84dbd12e35f"},{"name":"Aggiungi Contatto a Lista","id":"0da85782-c6b7-42e0-bd85-31a87eb11e61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"100321","description":"[Number] (Obbligatorio)
\nId inteno del gruppo ai quale assegnare il contatto.
\nÈ possibile specificare più gruppi separandoli con il carattere virgola \",\".
\nAd esempio:\n1245 oppure 1245,3432
Aggiunge un contatto già presente in rubrica a una lista contatti esistente.
\n\n\nIl \"Content-Type\" per le richieste PUT deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nIdentificativo univoco del contatto
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"61484fc8-1d6a-4c56-a3e7-84f2df2d47f0","name":"Aggiungi Contatto a Lista","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"100321","description":"[Number] *(Obbligatorio)*\n\nId inteno del gruppo ai quale assegnare il contatto.\n\nÈ possibile specificare **più gruppi** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**`1245`** oppure **`1245,3432`**","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId/groups/add","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId","groups","add"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:40:10 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0da85782-c6b7-42e0-bd85-31a87eb11e61"},{"name":"Rimuovi Contatto da Lista","id":"faa86156-7137-40b1-b5e1-0760df1e9604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"1234567","description":"[Number] (Obbligatorio)
\nId interno del gruppo dal quale si vuole rimuovere il contatto.
\nÈ possibile specificare più gruppi separandoli con il carattere virgola \",\".
\nAd esempio:\n1245 oppure 1245,3432
Rimuove un contatto già presente in rubrica da una lista contatti esistente.
\n\n\nIl \"Content-Type\" per le richieste PUT deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nIdentificativo univoco del contatto
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"d78aeb72-9d8a-48e6-ac5a-dc5ee305dbe4","name":"Rimuovi Contatto da Lista","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"100321","description":"[Number] *(Obbligatorio)*\n\nId inteno del gruppo dal quale si vuole rimuovere il contatto.\n\nÈ possibile specificare **più gruppi** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**`1245`** oppure **`1245,3432`**","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId/groups/remove","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId","groups","remove"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:41:11 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"faa86156-7137-40b1-b5e1-0760df1e9604"}],"id":"75d4d9d0-edbf-47de-b80b-874d8cb1dcc6","_postman_id":"75d4d9d0-edbf-47de-b80b-874d8cb1dcc6","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Liste Contatti","item":[{"name":"Liste Contatti","id":"150bb895-372d-473d-83a0-0864e8679d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/phonebook/group/list","description":"Ritorna l'elenco di tutte le liste contatti presenti in rubrica.
\nRitorna il dettaglio della lista contatti
\n[Number] (Obbligatorio)
\nId interno della lista contatti
\n","type":"text/plain"},"type":"any","value":"","key":"listId"}]}},"response":[{"id":"050b5fe9-6631-460f-bb7b-fba4f3775069","name":"Dettagliio Lista","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId"],"variable":[{"key":"listId","value":"","description":"[Number] *(Obbligatorio)*\n\nId interno della lista contatti"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3838,\n \"name\": \"Friends\",\n \"contactCount\": 1\n}"}],"_postman_id":"00bd963d-dec1-4169-87af-67a5e2f4b854"},{"name":"Contatti in una Lista","id":"b8ce0122-937d-4ebf-adf1-72c58d0a0ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/phonebook/group/:listId/contacts","description":"Ritorna tutti i contatti presenti in una lista.
\n[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito. Vedi paginazione.
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nNumero massimo di risultati che verranno restituiti. Vedi paginazione.
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[{"description":{"content":"[Number] (Obbligatorio)
\nId interno della lista contatti
\n","type":"text/plain"},"type":"any","value":"","key":"listId"}]}},"response":[{"id":"88c14bb8-725d-46b7-94ba-e06390cf0363","name":"Contatti in una Lista","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId/contacts","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId","contacts"],"query":[{"key":"offset","value":null,"description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito. Vedi [paginazione](#gestire-la-risposta).","disabled":true},{"key":"limit","value":null,"description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti. Vedi [paginazione](#gestire-la-risposta).","disabled":true}],"variable":[{"key":"listId","value":"","description":"[Number] *(Obbligatorio)*\n\nId interno della lista contatti"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"contacts\": [\n {\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"address\": \"via Italia 1\",\n \"city\": \"Roma\",\n \"postCode\": 144,\n \"province\": \"RM\",\n \"country\": \"IT\",\n \"email\": \"mario.rossi@fake.it\",\n \"homePhoneNumber\": \"\",\n \"groups\": [\n {\n \"id\": 13197,\n \"name\": \"Amici\"\n },\n {\n \"id\": 1947,\n \"name\": \"Lavoro\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"b8ce0122-937d-4ebf-adf1-72c58d0a0ebb"},{"name":"Nuova Lista","id":"55652168-5b86-4f00-b38e-0be9b23b4ae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Nuova Lista","description":"[String] (Obbligatorio)
\nNome della nuova lista contatti
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/phonebook/group","description":"Aggiunge una lista contatti alla rubrica
\n\n\nIl \"Content-Type\" per le richieste POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] *(Obbligatorio)
\nNuovo nome da assegnare alla lista contatti.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/phonebook/group/:listId","description":"Modifica una lista contatti esistente
\n\n\nIl \"Content-Type\" per le richieste PUT deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nId interno della lista contatti
\n","type":"text/plain"},"type":"any","value":"100321","key":"listId"}]}},"response":[{"id":"d9e6ac9e-2cae-4ec0-8d30-9805c1be4529","name":"Aggiorna Lista","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"New Name","description":"[String] *(Obbligatorio)\n\nNuovo nome da assegnare alla lista contatti.","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId"],"variable":[{"key":"listId","value":"100321","description":"[Number] *(Obbligatorio)*\n\nId interno della lista contatti"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:45:19 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9bc608b7-a739-4fb1-bac4-d87c4e6a46fe"},{"name":"Elimina Lista","id":"8331b917-7c0a-492b-8885-d6cdb11a2045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BaseUrl}}/rest/api/phonebook/group/:listId?delete_contacts=true","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","phonebook","group",":listId"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"[Boolean] (Opzionale)
\nSe valorizzato a true verranno eliminati definitivamente tutti i contatti appartenenti a questa lista contatti.
Default: false
\n","type":"text/plain"},"key":"delete_contacts","value":"true"}],"variable":[{"id":"e8d45dc8-6b4b-4a42-8641-e2922b7ba60d","description":{"content":"[Number] *(Obbligatorio)
\nNuovo nome da assegnare alla lista contatti.
\n","type":"text/plain"},"type":"any","value":"100321","key":"listId"}]}},"response":[{"id":"f5ffb33a-81ed-476c-ba02-b5a0ada4f873","name":"Elimina Lista","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId?delete_contacts=true","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId"],"query":[{"key":"delete_contacts","value":"true","description":"[Boolean] *(Opzionale)*\n\nSe valorizzato a `true` verranno _eliminati definitivamente_ tutti i contatti appartenenti a questa lista contatti.\n\nDefault: **false**"}],"variable":[{"key":"listId","value":"100321","description":"[Number] *(Obbligatorio)\n\nNuovo nome da assegnare alla lista contatti."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:46:31 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8331b917-7c0a-492b-8885-d6cdb11a2045"}],"id":"b21066fe-49d6-40c8-9d77-4848a7aa80d1","_postman_id":"b21066fe-49d6-40c8-9d77-4848a7aa80d1","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Campi Personalizzati","item":[{"name":"Lista Campi","id":"70d795fa-399e-432c-a976-0ec6cc0edccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/phonebook/customfields/list","description":"Lista dei campi personalizzati definiti dall'utente.
\nPer la creazione di nuovi campi personalizzati fare riferimento alla guida \"Personalizza i contatti\"
\nRestituisce la lista delle Informative Privacy pubblicate.
\nRestituisce la lista dei consensi GDPR pubblicati.
\nRestituisce lo stato attuale dei consensi GDPR accettati o rifiutati dal contatto.
\n[Number] (Obbligatorio)
\nId del contatto di cui si desidera ricevere lo storico dei consensi GDPR.
\n","type":"text/plain"},"type":"any","value":"","key":"contactId"}]}},"response":[{"id":"595eb424-c171-4078-84ff-0ee9e076479b","name":"Storico Consensi GDPR Contatto","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/history/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","history","contact",":contactId"],"variable":[{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nId del contatto di cui si desidera ricevere lo storico dei consensi GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4601,\n \"granted\": true,\n \"insert_date\": \"2020-10-13T08:15:21+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Privacy URL\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 7687,\n \"granted\": false,\n \"insert_date\": \"2020-10-12T16:25:53+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Do il consenso per le comunicazioni a terzi\"\n }\n ]\n}"}],"_postman_id":"89d1ec5e-bd5e-4bb8-b49f-bbfdfdbf290a"},{"name":"Storico Consensi GDPR Contatto","id":"b836d1b0-f68c-45e2-a20c-af24cd68649d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/gdpr/history/contact/:contactId","description":"Restituisce lo storico dei consensi GDPR accettati o rifiutati dal contatto.
\n[Number] (Obbligatorio)
\nId del contatto di cui si desidera ricevere lo storico dei consensi GDPR.
\n","type":"text/plain"},"type":"any","value":"","key":"contactId"}]}},"response":[{"id":"000f2d91-38f0-4816-9e78-17a14bce1442","name":"Storico Consensi GDPR Contatto","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/history/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","history","contact",":contactId"],"variable":[{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nId del contatto di cui si desidera ricevere lo storico dei consensi GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4601,\n \"granted\": true,\n \"insert_date\": \"2020-10-13T08:15:21+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Privacy URL\"\n },\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4326,\n \"granted\": false,\n \"insert_date\": \"2020-10-13T08:08:10+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Privacy\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 7687,\n \"granted\": false,\n \"insert_date\": \"2020-10-12T16:25:53+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Do il consenso per le comunicazioni a terzi\"\n }\n ]\n}"}],"_postman_id":"b836d1b0-f68c-45e2-a20c-af24cd68649d"},{"name":"Aggiunta Consenso GDPR","id":"e33773f7-51aa-4269-a851-00ae15f654cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1234","description":"[Number] (Obbligatorio)
\nSpecificare l'ID del consenso o privacy da aggiungere al contatto.
\n","type":"text"},{"key":"insert_date","value":"","description":"[String] (Opzionale)
\nData in cui il contatto ha dato il consenso (in formato yyyy-MM-ddTHH:mm:ssZ) .\nSe questo campo non viene valorizzato viene usata la data attuale.
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/gdpr/contact/add/:type/:contactId","description":"Aggiunge un consenso GDPR a un contatto.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Obbligatorio)
\nSpecificare il tipo di consenso che si vuole aggiungere\nPossbili valori: privacy, consent
[Number] (Obbligatorio)
\nId del contatto a cui si desidera aggiungere il consenso GDPR.
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"b94430a0-f0c4-4f40-8b26-4898b78c55b2","name":"Aggiunta Consenso GDPR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1234","description":"[Number] *(Obbligatorio)*\n\nSpecificare l'ID del consenso o privacy da aggiungere al contatto.","type":"text"},{"key":"insert_date","value":"","description":"[String] *(Opzionale)*\n\nData in cui il contatto ha dato il consenso (in formato **yyyy-MM-ddTHH:mm:ssZ**) .\nSe questo campo non viene valorizzato viene usata la data attuale.","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/contact/add/:type/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","contact","add",":type",":contactId"],"variable":[{"key":"type","value":"privacy","description":"[String] *(Obbligatorio)*\n\nSpecificare il tipo di consenso che si vuole aggiungere\nPossbili valori: `privacy`, `consent`"},{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nId del contatto a cui si desidera aggiungere il consenso GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 38413,\n \"granted\": true,\n \"insert_date\": \"2021-04-20T16:34:05+0200\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"api\",\n \"consent_title\": \"v3\"\n },\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2021-03-22T15:25:14+0100\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"form\",\n \"consent_title\": \"v1\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2020-12-10T09:05:57+0100\",\n \"ip\": \"5.157.101.77\",\n \"source\": \"form\",\n \"consent_title\": \"Do il consenso a ricevere comunicazioni, sconti e promozioni tramite SMS e email\"\n }\n ]\n}"}],"_postman_id":"e33773f7-51aa-4269-a851-00ae15f654cf"},{"name":"Rimozione Consenso GDPR","id":"0c1472db-c91f-445c-ac70-52f0113e3d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"","description":"[Number] (Obbligatorio)
\nSpecificare l'ID del consenso o privacy da rimuovere dal contatto.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/gdpr/contact/remove/:type/:contactId","description":"Rimuove un consenso GDPR da un contatto.
\n[String] (Obbligatorio)
\nSpecificare il tipo di consenso che si vuole rimuovere\nPossibili valori: privacy, consent
[Number] (Obbligatorio)
\nID del contatto dal quale si vuole rimuovere il consenso GDPR
\n","type":"text/plain"},"type":"any","value":"","key":"contactId"}]}},"response":[{"id":"3ecdc4c8-6b33-4377-aaf3-60597eee18c8","name":"Rimozione Consenso GDPR","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"","description":"[Number] *(Obbligatorio)*\n\nSpecificare l'ID del consenso o privacy da rimuovere dal contatto.","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/contact/remove/:type/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","contact","remove",":type",":contactId"],"variable":[{"key":"type","value":"","description":"[String] *(Obbligatorio)*\n\nSpecificare il tipo di consenso che si vuole rimuovere\nPossbili valori: `privacy`, `consent`"},{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nId del contatto dal quale si vuole rimuovere il consenso GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 38413,\n \"granted\": true,\n \"insert_date\": \"2021-04-20T16:34:05+0200\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"api\",\n \"consent_title\": \"v3\"\n },\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2021-03-22T15:25:14+0100\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"form\",\n \"consent_title\": \"v1\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2020-12-10T09:05:57+0100\",\n \"ip\": \"5.157.101.77\",\n \"source\": \"form\",\n \"consent_title\": \"Do il consenso a ricevere comunicazioni, sconti e promozioni tramite SMS e email\"\n }\n ]\n}"}],"_postman_id":"0c1472db-c91f-445c-ac70-52f0113e3d93"}],"id":"c809311c-1381-443a-8be2-3137413a622e","_postman_id":"c809311c-1381-443a-8be2-3137413a622e","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"User","item":[{"name":"Get user","id":"3b75d812-9aae-4e76-bc50-4d7effc192a5","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/user","description":"Restituisce l'anagrafica ed il credito relativo al tuo profilo su Smshosting.
\n[String] (Obbligatorio)
\nLo username deve essere una stringa alfanumerica di lunghezza compresa tra 5 e 50 caratteri.
\nOltre a lettere e numeri può contenere i seguenti caratteri: . @ _ -
[String] (Obbligatorio)
\nLa password deve essere una stringa alfanumerica di lunghezza compresa tra 5 e 20 caratteri.
\n","type":"text"},{"key":"name","value":"Mario","description":"[String] (Obbligatorio)
\nNome del titolare dell'account
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] (Obbligatorio)
\nCognome del titolare dell'account
\n","type":"text"},{"key":"email","value":"mariorossi@fakeaddress.it","description":"[String] (Obbligatorio)
\nIndirizzo email valido
\n","type":"text"},{"key":"companyType","value":"true","description":"[Boolean] (Opzionale)
\nValorizzare a true nel caso l'account sia associato ad un azienda
\nPossibili valori [true|false]
[String] (Opzionale)
\nObbligatorio se companyType=true
Ragione sociale dell'azienda
\n","type":"text","disabled":true},{"key":"address","value":"","description":"[String] (Opzionale)
\nIndirizzo
\n","type":"text","disabled":true},{"key":"city","value":"","description":"[String] (Opzionale)
\nCittà
\n","type":"text","disabled":true},{"key":"postcode","value":"","description":"[String] (Opzionale)\nCodice di avviamento postale
\n","type":"text","disabled":true},{"key":"province","value":"","description":"[String] (Opzionale)
\nProvincia
\n","type":"text","disabled":true},{"key":"country","value":"","description":"[String] (Opzionale)
\nNazione
\n","type":"text","disabled":true},{"key":"birthdate","value":"","description":"[String] (Opzionale)
\nData di nascita nel formato yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"[String] (Opzionale)
\nNumero di telefono
\n","type":"text","disabled":true},{"key":"msisdn","value":"","description":"[String] (Opzionale)
\nNumero di cellulare
\n","type":"text","disabled":true},{"key":"taxcode","value":"","description":"[String] (Opzionale)
\nCodice Fiscale
\n","type":"text","disabled":true},{"key":"vatnumber","value":"","description":"[String] (Opzionale)
\nPartita IVA
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/reseller/subuser","description":"Crea un nuovo sub-account
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Vedi Nuovo sub-account
\n","type":"text"},{"key":"name","value":"Mario","description":"Vedi Nuovo sub-account
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"Vedi Nuovo sub-account
\n","type":"text"},{"key":"email","value":"mariorossi@fakeaddress.it","description":"Vedi Nuovo sub-account
\n","type":"text"},{"key":"companyType","value":"true","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"businessname","value":"ACME COMPANY","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"address","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"postcode","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"province","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"birthdate","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"msisdn","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"taxcode","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true},{"key":"vatnumber","value":"","description":"Vedi Nuovo sub-account
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/reseller/subuser/:subuserId","description":"Modifica l'anagrafica di un sub-account
\n\n\nIl \"Content-Type\" per questa richiesta PUT deve essere \"application/x-www-form-urlencoded\"
\n
Vedi chiamata nuovo sub-account per il dettaglio dei dati ritornati
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","reseller","subuser",":subuserId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Number] (Obbligatorio)
\nIdentificativo del sub-account che si vuole modificare
\n","type":"text/plain"},"type":"any","value":"","key":"subuserId"}]}},"response":[{"id":"0b7d5fa6-b7cc-4f6d-bd3c-4580de093aa6","name":"Modifica Sub-Account","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"mariorossi","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"name","value":"Mario","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"lastname","value":"Rossi","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"email","value":"mariorossi@fakeaddress.it","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"companyType","value":"true","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"businessname","value":"ACME COMPANY","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"address","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"city","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"postcode","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"province","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"country","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"birthdate","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"phone","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"msisdn","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"taxcode","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"vatnumber","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/reseller/subuser/:subuserId","host":["{{BaseUrl}}"],"path":["rest","api","reseller","subuser",":subuserId"],"variable":[{"key":"subuserId","value":"","description":"[Number] *(Obbligatorio)*\n\nIdentificativo del sub-account che si vuole modificare"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"username\": \"mariorossi\",\n \"email\": \"mariorossi@fakeaddress.it\",\n \"address\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"msisdn\": \"\",\n \"sender\": \"ACMECOMPANY\",\n \"registrationDate\": \"2015-08-04T12:04:56+0200\",\n \"expirationDate\": \"2016-08-04T12:04:56+0200\",\n \"credit\": 0.6,\n \"italysms\": 5,\n \"senderAlias\": [],\n \"authKey\": \"0000\",\n \"authSecret\": \"0000\"\n}"}],"_postman_id":"159b9a2e-b865-4beb-b658-c9b7ca9ec821"},{"name":"Elimina Sub-Account","id":"1ce121f9-c061-4093-a541-cf5783b53a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BaseUrl}}/rest/api/reseller/subuser/:accountId","description":"Cancella in maniera definitiva un sub-account
\n[Number] (Obbligatorio)
\nid del sub-account da eliminare
Restituisce il dettaglio del sub-account
\nVedi chiamata nuovo sub-account per il dettaglio dei dati ritornati
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","reseller","subuser",":accountId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"id":"41884542-94b5-4ef6-8608-9fd1a53c1707","description":{"content":"[Number] (Obbligatorio)
\nid del sub-account di cui si vuole recuperare il dettaglio
Cerca un sub-account in base ai parametri forniti.
\nVedi chiamata nuovo sub-account per il dettaglio dei dati ritornati per il singolo account.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","reseller","subuser","search"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"[String] (Opzionale)
\nRicerca un sub-account per username, nome e cognome
\n","type":"text/plain"},"key":"query","value":"mariorossi"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nData di creazione in formato yyyy-MM-ddTHH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2017-03-24T00:00:00+0100"},{"disabled":true,"description":{"content":"[String] (Opzionale)\nData di creazione in formato yyyy-MM-ddTHH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2020-07-19T00:00:00+0100"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito
\nVedi dettagli paginazione
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"20"},{"disabled":true,"description":{"content":"[Number] (Opzionale)
\nNumero di risultati che verranno restituiti
\nVedi dettagli paginazione
\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"ecdb88cd-2f52-401e-8a3d-9b173b86d641","name":"Cerca Sub-Account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/reseller/subuser/search?query=mariorossi","host":["{{BaseUrl}}"],"path":["rest","api","reseller","subuser","search"],"query":[{"key":"query","value":"mariorossi","description":"[String] *(Opzionale)*\n\nRicerca un sub-account per username, nome e cognome"},{"key":"fromDate","value":"2017-03-24T00:00:00+0100","description":"[String] *(Opzionale)*\n\nData di creazione in formato **yyyy-MM-ddTHH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2020-07-19T00:00:00+0100","description":"[String] *(Opzionale)*\nData di creazione in formato **yyyy-MM-ddTHH:mm:ssZ**","disabled":true},{"key":"offset","value":"20","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito\n\nVedi [dettagli paginazione](#gestire-la-risposta)\n\nDefault: **0**","disabled":true},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\n\nNumero di risultati che verranno restituiti\n\nVedi [dettagli paginazione](#gestire-la-risposta)\n\nDefault: **20**","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"subUserList\": [\n {\n \"id\": \"1\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"username\": \"mariorossi\",\n \"email\": \"mariorossi@fakeaddress.it\",\n \"address\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"msisdn\": \"\",\n \"sender\": \"ACMECOMPANY\",\n \"registrationDate\": \"2015-08-04T12:04:56+0200\",\n \"expirationDate\": \"2016-08-04T12:04:56+0200\",\n \"credit\": 0.6,\n \"italysms\": 5,\n \"senderAlias\": [],\n \"authKey\": \"0000\",\n \"authSecret\": \"0000\"\n }\n ]\n}"}],"_postman_id":"a5d1a1a2-d9ce-453b-988a-60c1f01b345b"},{"name":"Crea Ordine","id":"d5188b3a-7e25-4676-8908-e0269dfa917f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"packId","value":"1234","description":"[Number] (Opzionale: valorizzare almeno uno tra packId e newPackSmsItaly)
\nIdentificativo del pacchetto SMS da attivare. Utilizzare la chiamata Lista Pacchetti per recuperare gli identificativi
\n","type":"text"},{"key":"newPackSmsItaly","value":"14","description":"[Number] (Opzionale: valorizzare almeno uno tra packId e newPackSmsItaly)
\nNumero di SMS da assegnare: verrà creato un nuovo pacchetto.
\n","type":"text","disabled":true},{"key":"newPackUnitCostItaly","value":"","description":"[Decimal] (Opzionale)
\nCosto singolo usato nella creazione del nuovo pacchetto. Viene utilizzato in combinazione con il parametro newPackSmsItaly
\nDefault: 0.07 €
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/reseller/subuser/:accountId/order","description":"Crea e attiva un ordine per un sub-account.
\nE' possbile assegnare un pacchetto SMS esistente o, alternativamente, creare un nuovo pacchetto indicando semplicemente il numero di SMS da assegnare.
\n\n\nIl \"Content-Type\" per le richieste POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del sub-account per cui si vuole generare un ordine
Ritorna la lista dei pacchetti SMS in vendita.
\nAzzera il credito di un sub-account e lo riassegna all'account rivenditore.
\n\n\nIl \"Content-Type\" per le richieste POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nid del sub-account per cui si vuole generare un ordine
Queste API ti permettono di gestire il tuo piano rivenditore e i tuoi subaccount.
\n\n\n","_postman_id":"72b89c5c-1113-46c5-9b3a-e0ea9ab049fe","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Invio RCS","item":[{"name":"Preventivo Invio RCS","id":"d370e96f-8883-48fc-a57f-cadae2e08e7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"393400000000","description":"Per poter utilizzare le Reseller API è necessario avere un account rivenditore e richiedere la specifica abilitazione.\nRichiedila qui
\n
[String] (Opzionale valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono (max 1000 numeri) separandoli con il carattere virgola \",\".
\nAd esempio:
\n393481234567 oppure 393481234567,393481234568,393481234568
Alternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).
\nAd esempio:
\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviare
\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:
1 oppure 1,2
\n","type":"text","disabled":true},{"key":"agentId","value":"id agent","description":"[String] (Obbligatorio)
\nId dell'Agent che si vuole utilizzare per inviare il messaggio RCS
\n","type":"text"},{"key":"contentMessage","value":"{\"contentMessage\":{\"text\":\"Hi there!\",\"suggestions\":[]}}","description":"[String] (Obbligatorio)
\nStringa rappresentante il JSON che contiene il messaggio RCS.
\nFare riferimento a https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages
\n","type":"text"},{"key":"fallbackSms","value":"true","description":"[boolean] (Obbligatorio)
\nTrue se si vuole abilitare il fallback sms
\n","type":"text"},{"key":"fromSms","value":"mittente SMS","description":"[String] (Opzionale)
\nIl mittente dell'SMS di fallback.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.
\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.
\nI mittenti non verificati verranno rimpiazzati con un mittente numerico casuale.
\n","type":"text"},{"key":"textSms","value":"testo SMS ","description":"[String] (Opzionale)
\nObbligatorio se fallbackSms è true.
\nTesto del messaggio sms di fallback.
\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.
\nAlcuni caratteri estesi occupano 2 caratteri. Nel caso di SMS che sforino la lunghezza standard di 160 caratteri solo a causa di alcuni caratteri estesi, questi saranno rimpiazzati con caratteri semplici mantendo il costo a 1 SMS invece che 2.
\nIl testo può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi ${nome proprietà}
\nNel caso il testo contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]\ntext=Invio sms di test a ${nome}
\n","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:
\n7BIT - Encoding standard per i messaggi GSM. La lunghezza massima per un singolo sms è di 160 caratteri.
\nUCS2 - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di 70 caratteri.
\nAUTO - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.
\nDefault : 7BIT
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/rcs/message/estimate","description":"Calcolo del credito necessario per un invio RCS (singolo o invio multiplo).
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Opzionale valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono (max 10 numeri) separandoli con il carattere virgola \",\".\nNel caso di più di 10 destinatari consigliamo di usare la chiamata di Invio SMS Bulk.
\nAd esempio:
\n393481234567 oppure 393481234567,393481234568,393481234568
Alternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).
\nAd esempio:
\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviare
\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:
1 oppure 1,2
\n","type":"text","disabled":true},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"[String] (Opzionale)
\nData (in formato yyyy-MM-ddTHH:mm:ssZ) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere Z indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).
\nAd esempio:\n2014-12-25T08:00:00+0200 indica il 25/12/2014 alle 08:00:00 riferito al GMT +2
\n","type":"text","disabled":true},{"key":"agentId","value":"id agent","description":"[String] (Obbligatorio)
\nId dell'Agent tramite cui si vuole inviare il messaggio RCS
\n","type":"text"},{"key":"contentMessage","value":"{\"contentMessage\":{\"text\":\"Hi there!\",\"suggestions\":[]}}","description":"[String] (Opzionale valorizzare almeno uno tra contentMessage e templateId)
\nStringa rappresentante il JSON che contiene il messaggio RCS.
\nFare riferimento a https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages
\n","type":"text"},{"key":"templateId","value":"id template","description":"[String] (Opzionale valorizzare almeno uno tra contentMessage e templateId)\nId del template da utilizzare per l'invio. Valorizzare uno tra templateId e contentMessage
\n","type":"text","disabled":true},{"key":"fallbackSms","value":"true","description":"[boolean] (Obbligatorio)
\nTrue se si vuole abilitare il fallback sms
\n","type":"text"},{"key":"fromSms","value":"mittente SMS","description":"[String] (Opzionale)
\nIl mittente dell'SMS di fallback.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.
\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.
\nI mittenti non verificati verranno rimpiazzati con un mittente numerico casuale.
\n","type":"text"},{"key":"textSms","value":"Hi there!","description":"[String] (Opzionale)
\nObbligatorio se fallbackSms è true.
\nTesto del messaggio sms di fallback.
\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.
\nAlcuni caratteri estesi occupano 2 caratteri. Nel caso di SMS che sforino la lunghezza standard di 160 caratteri solo a causa di alcuni caratteri estesi, questi saranno rimpiazzati con caratteri semplici mantendo il costo a 1 SMS invece che 2.
\nIl testo può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi ${nome proprietà}
\nNel caso il testo contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]\ntext=Invio sms di test a ${nome}
\n","type":"text"},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Opzionale)
\nUn identificatore personale dell'invio.
\nConsente di assegnare a tutti i messaggi inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. Massimo 60 caratteri.
\n","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:
\n7BIT - Encoding standard per i messaggi GSM. La lunghezza massima per un singolo sms è di 160 caratteri.
\nUCS2 - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di 70 caratteri.
\nAUTO - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.
\nDefault : 7BIT
\n","type":"text","disabled":true},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Opzionale)
\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) del messaggio.
\nVedi Gestione RCS Status Callback
\n","type":"text"},{"key":"sandbox","value":"true","description":"[String] (Opzionale)
\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.
\nPossibili valori true/false
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/rcs/message/send","description":"Invio di un messaggio ad uno o più destinatari singoli o verso uno o più gruppi della rubrica.
\nÈ possibile testare l'invio valorizzando il parametro sandbox a true nella richiesta.
Il parametro statusCallback consente di registrare un URL al quale sarà inviata via HTTP una notifica con lo stato (Consegnato, Non Consegnato, ecc...) del messaggio.
\n\n\n\nPoni particolare attenzione al fatto che l'id del messaggio potrebbe essere un intero a 64 bit (int64)
\n
Controlla che la tua piattaforma sia in grado di gestirlo!
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Opzionale valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono (max 1000 numeri) separandoli con il carattere virgola \",\".
\nAd esempio:
\n393481234567 oppure 393481234567,393481234568,393481234568
Alternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).
\nAd esempio:
\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviare
\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:
1 oppure 1,2
\n","type":"text","disabled":true},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"[String] (Opzionale)
\nData (in formato yyyy-MM-ddTHH:mm:ssZ) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere Z indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).
\nAd esempio:\n2014-12-25T08:00:00+0200 indica il 25/12/2014 alle 08:00:00 riferito al GMT +2
\n","type":"text","disabled":true},{"key":"agentId","value":"id agent","description":"[String] (Obbligatorio)
\nId dell'Agent tramite cui si vuole inviare il messaggio RCS
\n","type":"text"},{"key":"contentMessage","value":"{\"contentMessage\":{\"text\":\"Hi there!\",\"suggestions\":[]}}","description":"[String] (Opzionale valorizzare almeno uno tra contentMessage e templateId)
\nStringa rappresentante il JSON che contiene il messaggio RCS.
\nFare riferimento a https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages
\n","type":"text"},{"key":"templateId","value":"id template","description":"[String] (Opzionale valorizzare almeno uno tra contentMessage e templateId)\nId del template da utilizzare per l'invio. Valorizzare uno tra templateId e contentMessage
\n","type":"text","disabled":true},{"key":"fallbackSms","value":"true","description":"[boolean] (Obbligatorio)
\nTrue se si vuole abilitare il fallback sms
\n","type":"text"},{"key":"fromSms","value":"mittente SMS","description":"[String] (Opzionale)
\nIl mittente dell'SMS di fallback.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.
\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.
\nI mittenti non verificati verranno rimpiazzati con un mittente numerico casuale.
\n","type":"text"},{"key":"textSms","value":"Hi there!","description":"[String] (Opzionale)
\nObbligatorio se fallbackSms è true.
\nTesto del messaggio sms di fallback.
\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.
\nAlcuni caratteri estesi occupano 2 caratteri. Nel caso di SMS che sforino la lunghezza standard di 160 caratteri solo a causa di alcuni caratteri estesi, questi saranno rimpiazzati con caratteri semplici mantendo il costo a 1 SMS invece che 2.
\nIl testo può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi ${nome proprietà}
\nNel caso il testo contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]\ntext=Invio sms di test a ${nome}
\n","type":"text"},{"key":"transactionId","value":"51e533f557062a2e0dfce81d064a60db","description":"[String] (Opzionale)
\nUn identificatore personale dell'invio.
\nConsente di assegnare a tutti i messaggi inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. Massimo 60 caratteri.
\n","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:
\n7BIT - Encoding standard per i messaggi GSM. La lunghezza massima per un singolo sms è di 160 caratteri.
\nUCS2 - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di 70 caratteri.
\nAUTO - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.
\nDefault : 7BIT
\n","type":"text","disabled":true},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Opzionale)
\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) del messaggio.
\nVedi Gestione RCS Status Callback
\n","type":"text"},{"key":"sandbox","value":"true","description":"[String] (Opzionale)
\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.
\nPossibili valori true/false
\n","type":"text","disabled":true},{"key":"transactionCallback","value":"https://tuodominio.com/tuo-percorso-callback","type":"text","description":"[String] (Opzionale)
\nUn identificatore personale dell'invio.
\nConsente di assegnare a tutti i messaggi inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per la ricerca per stato. Massimo 60 caratteri.\"
\n"}]},"url":"{{BaseUrl}}/rest/api/rcs/message/sendbulk","description":"Modalità di invio sms asincrono da utilizzare con un numero elevato di destinatari (Più di 10 destinatari per singola richiesta).
\nUna volta inviata la richiesta viene restituito un transactionId utile a identificare sucessivamente i messaggi.
\nNel caso l'invio non possa essere completato a causa di un errore verrà inviata un'email contentente il codice di errore.
\nNota: Se invii fino a 10 destinatari per singola richiesta ti consigliamo di utilizzare la funzione di Invio RCS
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Opzionale) -> valorizzare almeno uno tra i parametri id o transactionId
id interno del messaggio inviato.
È possibile specificare più id separandoli con il carattere virgola \",\".
\nAd esempio:\n12312 oppure 432432,543543,435435
\n","type":"text"},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Opzionale) -> valorizzare almeno uno tra i parametri id o transactionId
transactionId assegnato all'invio
Annulla l'invio di un messaggio non ancora inviato (invio differito).
\nLa chiamata ritorna la lista dei messaggi annullati.
\nPer il dettaglio delle proprietà di ogni singolo messaggio vedi la Descrizione Risposta della funzione Cerca Rcs.
\n","urlObject":{"path":["rest","api","rcs","message","cancel"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0497c34a-a1c7-4b0b-83e2-3d13e499c18a","name":"Annulla Invio RCS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","description":"[Number] *(Opzionale ¹)*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**12312** oppure **432432,543543,435435**","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] *(Opzionale ¹)*\n\n**transactionId** assegnato all'invio","type":"text"}]},"url":"{{BaseUrl}}/rest/api/rcs/message/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"to\": \"393331111111\",\n \"text\": \"Ciao Rossi!\",\n \"from\": \"DemoSMS\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2022-05-27T17:41:04+0200\",\n \"transactionId\": \"rkEctAS0WRZzZTWtDXuGiLh5QWsgStYv59tnLRsj9UwA5BWjdbTxFhydYSb64TaU\",\n \"price\": 0.085,\n \"agent\": \"Agent default\",\n \"contentMessage\": \"{\\\"contentMessage\\\":{\\\"text\\\":\\\"Hi there!\\\",\\\"suggestions\\\":[]}}\",\n \"contentType\": \"card\",\n \"sentAs\": \"unknown\"\n }\n]"}],"_postman_id":"c37feee5-5a99-4ac5-8816-161ba16be3f0"},{"name":"Cerca RCS","id":"f76c03c8-4b62-4cd5-ab1a-5b4bf7024a05","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/rcs/message/search?id=450189291&offset=0&limit=20","description":"Cerca tra i messaggi RCS inviati.
\nValorizzare almeno uno tra i seguenti parametri:
\nid
\ntransactionId
\nmsisdn
\nfromDate
\nstatus
\n[String] (Opzionale)
\nId interno del messaggio inviato.
\nÈ possibile specificare più id separandoli con il carattere virgola \",\". (Massimo 2000 id).
\nAd esempio:
\n12312 oppure 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":"450189291"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\ntransactionId assegnato all'invio.
\n","type":"text/plain"},"key":"transactionId","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nNumero al quale è stato inviato il messaggio
\n","type":"text/plain"},"key":"msisdn","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nCerca i messaggi inviati da questa data (formato yyyy-MM-ddTHH:mm:ssZ)
\nIl carattere Z indica il timezone nel formato RFC822 4-digit. \nPer l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno.
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nCerca i messaggi inviati fino a questa data (formato yyyy-MM-ddTHH:mm:ssZ)
\n","type":"text/plain"},"key":"toDate","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nStato dei messaggi [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)
\n","type":"text/plain"},"key":"status","value":"PENDING"},{"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.
\nEsempio:\nSe la ricerca trova 100 messaggi, il campo offset viene valorizzato a 50 ed il campo limit a 10 verranno restituiti i messaggi da 51 a 60.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Opzionale)
\nNumero di risultati che verranno restituiti.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"6f8c034d-3438-4c47-816a-a6a16386ca30","name":"Cerca Messaggi RCS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/rcs/message/search?id&transactionId=&msisdn&fromDate&toDate&status=PENDING&offset=0&limit=20","host":["{{BaseUrl}}"],"path":["rest","api","rcs","message","search"],"query":[{"key":"id","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**12312** oppure **432432,543543,435435**"},{"key":"transactionId","value":"","description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\n**transactionId** assegnato all'invio."},{"key":"msisdn","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero al quale è stato inviato il messaggio"},{"key":"fromDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati da questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)\n\nIl carattere **Z** indica il timezone nel formato RFC822 4-digit. _Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno_."},{"key":"toDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati fino a questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)"},{"key":"status","value":"PENDING","description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nStato degli sms [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)"},{"key":"offset","value":"0","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\nSe la ricerca trova 100 sms, il campo **offset** viene valorizzato a 50 ed il campo **limit** a 10 verranno restituiti gli sms da 51 a 60.\n**Default : 0**"},{"key":"limit","value":"20","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero di risultati che verranno restituiti.\n**Default: 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"rcsList\": [\n {\n \"id\": 70,\n \"to\": \"393000000000\",\n \"text\": \"Hi There!\",\n \"from\": \"DemoSMS\",\n \"status\": \"PENDING\",\n \"insertDate\": \"2022-05-27T17:41:04+0200\",\n \"transactionId\": \"rkEctAS0WRZzZTWtDXuGiLh5QWsgStYv59tnLRsj9UwA5BWjdbTxFhydYSb64TaU\",\n \"price\": 0.085,\n \"agentId\": 8,\n \"contentMessage\": \"{\\\"contentMessage\\\":{\\\"text\\\":\\\"Hi there!\\\",\\\"suggestions\\\":[]}}\",\n \"contentType\": \"text\",\n \"channel\": \"sms\"\n }\n ]\n}"}],"_postman_id":"f76c03c8-4b62-4cd5-ab1a-5b4bf7024a05"},{"name":"RCS Agent List","id":"890600e9-0273-402a-a80b-a899c8f2cae2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/rcs/agent/list","description":"Ritorna la lista degli agent RCS configurati.
\nRitorna la lista dei template RCS configurati.
\nLa risposta contiene un JSON contenente una lista di template , ognuno con le seguenti proprietà:
Restituisce il dettaglio di un singolo modello whatsapp.
\nCerca tra i messaggi Whatsapp inviati.
\nValorizzare almeno uno tra i seguenti parametri:
\n[String] (Opzionale)
\nId interno del messaggio inviato.
\nÈ possibile specificare più id separandoli con il carattere virgola \",\". (Massimo 2000 id).
\nAd esempio:\n12312 oppure 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"[String] (Opzionale)
\ntransactionId assegnato all'invio.
\n","type":"text/plain"},"key":"transactionId","value":"123456789ABCDE"},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nNumero al quale è stato inviato il messaggio
\n","type":"text/plain"},"key":"msisdn","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nCerca i messaggi inviati da questa data (formato yyyy-MM-ddTHH:mm:ssZ)\nIl carattere Z indica il timezone nel formato RFC822 4-digit.
\nPer l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno.
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nCerca i messaggi inviati fino a questa data (formato yyyy-MM-ddTHH:mm:ssZ)
\n","type":"text/plain"},"key":"toDate","value":""},{"disabled":true,"description":{"content":"[String] (Opzionale)
\nStato dei messaggi [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"[Number] (Opzionale)
\nPosizione del primo risultato che verrà restituito.\nEsempio:\nSe la ricerca trova 100 messaggi, il campo offset viene valorizzato a 50 ed il campo limit a 10 verranno restituiti i messaggi da 51 a 60.
\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Opzionale)
\nNumero di risultati che verranno restituiti.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"2bbc00a1-266b-4ec1-a5e8-6eec9b3eb216","name":"Cerca Whatsapp","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseUrl}}/rest/api/wa/message/search?id=&transactionId=DZNyyWr3Fd59iidfSSy2GU3im1aozQeE2qSyk6d1rwTDUa2ybuMI7IxDWPE1BS0j&offset=0&limit=10","host":["{{BaseUrl}}"],"path":["rest","api","wa","message","search"],"query":[{"key":"id","value":""},{"key":"transactionId","value":"DZNyyWr3Fd59iidfSSy2GU3im1aozQeE2qSyk6d1rwTDUa2ybuMI7IxDWPE1BS0j"},{"key":"msisdn","value":"","disabled":true},{"key":"fromDate","value":"","disabled":true},{"key":"toDate","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"offset","value":"0"},{"key":"limit","value":"10"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 10\n },\n \"waList\": [\n {\n \"id\": 2692017410,\n \"to\": \"393400000000\",\n \"fromSms\": \"-\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2023-09-25T10:18:42+0200\",\n \"dataDifferito\": \"2023-09-27T09:00:00+0200\",\n \"transactionId\": \"DZNyyWr3Fd59iidfSSy2GU3im1aozQeE2qSyk6d1rwTDUa2ybuMI7IxDWPE1BS0j\",\n \"price\": 0,\n \"phoneNumberId\": 3,\n \"contentMessage\": \"{\\\"type\\\":\\\"template\\\",\\\"template\\\":{\\\"namespace\\\":\\\"867f4be9_6b3d_4884_be59_123d372a3819\\\",\\\"name\\\":\\\"testmediaimg\\\",\\\"language\\\":{\\\"code\\\":\\\"it\\\"},\\\"components\\\":[{\\\"type\\\":\\\"header\\\",\\\"parameters\\\":[{\\\"type\\\":\\\"image\\\",\\\"image\\\":{\\\"link\\\":\\\"https://beeediot-svil.s3.eu-west-1.amazonaws.com/msgeditor-test/public/1/50/51_loginlogo_1627887014900.jpg\\\"}}]},{\\\"type\\\":\\\"body\\\",\\\"parameters\\\":[{\\\"type\\\":\\\"text\\\",\\\"text\\\":\\\"Marco\\\"}]}]}}\",\n \"sentAs\": \"unknown\"\n }\n ]\n}"}],"_postman_id":"db3216a1-b6e5-4d7a-8a21-af6fc337e4fe"},{"name":"Lista Numeri","id":"fbf66c6a-c885-45d2-9885-6a7dc491f6c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/wa/phonenumber/list","description":"Ritorna la lista dei numeri Whatsapp configurati.
\n[String] (Opzionale valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono (max 10 numeri) separandoli con il carattere virgola \",\".\nNel caso di più di 10 destinatari consigliamo di usare la chiamata di Invio SMS Bulk.
\nAd esempio:\n393481234567 oppure 393481234567,393481234568,393481234568
Alternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.
\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).
\nAd esempio:\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n"},{"key":"group","value":"","type":"text","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviare\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:\n1 oppure 1,2
[String] (Opzionale)
\nData (in formato yyyy-MM-ddTHH:mm:ssZ) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere Z indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).
\nAd esempio:\n2014-12-25T08:00:00+0200 indica il 25/12/2014 alle 08:00:00 riferito al GMT +2
\n","disabled":true},{"key":"phoneNumberId","value":"3","type":"text","description":"[String] (Opzinale valorizzare almeno uno tra phoneNumberId e phoneNumber)
\nId del numero che si vuole usare per inviare il messaggio Whatsapp
\n"},{"key":"phoneNumber","value":"","type":"text","description":"[String] (Opzinale valorizzare almeno uno tra phoneNumberId e phoneNumber)
\nNumero che si vuole usare per inviare il messaggio Whatsapp
\n","disabled":true},{"key":"contentMessage","value":"{... JSON CONTENT ...}","type":"text","description":"[String] (Obbligatorio)\nStringa rappresentante il JSON che contiene il messaggio Whatsapp
\nSe si volesse utilizzare un template esistente, consigliamo prima di effettuare la richiesta Dettaglio Modello e inserire qui il JSON restituito nella proprietà exampleSendPayload
\nIl contentMessage (nei parameters) può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario. Il placeholder va specificato con la sintassi ${nome proprietà}
\nNel caso il contentMessage contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.\nAd esempio:
\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]
\ncontentMessage = ....\"parameters\": [{\"type\": \"text\",\"text\": \"${nome}\"}]....
\nPer le specifiche del JSON, fare riferimento a https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages
\n"},{"key":"fallbackSms","value":"true","type":"text","description":"[boolean] (Obbligatorio)
\nTrue se si vuole abilitare il fallback sms
\n"},{"key":"fromSms","value":"SMS_SENDER","type":"text","description":"[String] (Opzionale)
\nIl mittente dell'SMS di fallback.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.
\nI mittenti non verificati verranno rimpiazzati con un mittente numerico casuale.
\n"},{"key":"textSms","value":"SMS CONTENT","type":"text","description":"[String] (Opzionale)
\nObbligatorio se fallbackSms è true.
\nTesto del messaggio sms di fallback.
\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.
\nAlcuni caratteri estesi occupano 2 caratteri. Nel caso di SMS che sforino la lunghezza standard di 160 caratteri solo a causa di alcuni caratteri estesi, questi saranno rimpiazzati con caratteri semplici mantendo il costo a 1 SMS invece che 2.
\nIl testo può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi ${nome proprietà}\nNel caso il testo contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]\ntext=Invio sms di test a ${nome}
\n"},{"key":"transactionId","value":"","type":"text","description":"[String] (Opzionale)
\nUn identificatore personale dell'invio.
\nConsente di assegnare a tutti i messaggi inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. Massimo 60 caratteri.
\n","disabled":true},{"key":"statusCallback","value":"","type":"text","description":"[String] (Opzionale)
\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) del messaggio.
\n","disabled":true},{"key":"encoding","value":"","type":"text","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.
\nI possibili valori sono:
\nDefault : 7BIT
\n","disabled":true},{"key":"sandbox","value":"","type":"text","description":"[String] (Opzionale)
\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.
\nPossibili valori true/false
\n","disabled":true}]},"url":"{{BaseUrl}}/rest/api/wa/message/send","description":"Invio di un messaggio ad uno o più destinatari singoli o verso uno o più gruppi della rubrica.
\nÈ possibile testare l'invio valorizzando il parametro sandbox a true nella richiesta.
Il parametro statusCallback consente di registrare un URL al quale sarà inviata via HTTP una notifica con lo stato (Consegnato, Non Consegnato, ecc...) del messaggio.
\n\n\n\nPoni particolare attenzione al fatto che l'id del messaggio potrebbe essere un intero a 64 bit (int64)
\n
Controlla che la tua piattaforma sia in grado di gestirlo!
\n\nSe vuoi inviare un template esistente, dovrai inserire nel parametro ContentMessage un JSON formattato come quello ottenuto nella proprietà exampleSendPayload della funzione Dettaglio Modello
\n
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[String] (Opzionale valorizzare almeno uno tra to e group)
\nIl destinatario del messaggio.
\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono (max 1000 numeri) separandoli con il carattere virgola \",\".
\nAd esempio:\n393481234567 oppure 393481234567,393481234568,393481234568\nAlternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.
Ogni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).
\nAd esempio:\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n"},{"key":"group","value":"","type":"text","description":"[String] (Opzionale valorizzare almeno uno tra to e group)
\nId del gruppo in Rubrica al quale inviare\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".
\nAd esempio se nellla rubrica sono presenti i gruppi Amici (id=1) e Scuola (id=2) sarà possibile indicare:\n1 oppure 1,2
[String] (Opzionale)
\nData (in formato yyyy-MM-ddTHH:mm:ssZ) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.
\nIl carattere Z indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).
\nAd esempio:\n2014-12-25T08:00:00+0200 indica il 25/12/2014 alle 08:00:00 riferito al GMT +2
\n","disabled":true},{"key":"phoneNumberId","value":"3","type":"text","description":"[String] (Opzinale valorizzare almeno uno tra phoneNumberId e phoneNumber)
\nId del numero che si vuole usare per inviare il messaggio Whatsapp
\n"},{"key":"phoneNumber","value":"","type":"text","description":"[String] (Opzinale valorizzare almeno uno tra phoneNumberId e phoneNumber)
\nNumero che si vuole usare per inviare il messaggio Whatsapp
\n","disabled":true},{"key":"contentMessage","value":"{... JSON CONTENT ...}","type":"text","description":"[String] (Obbligatorio)\nStringa rappresentante il JSON che contiene il messaggio Whatsapp
\nSe si volesse utilizzare un template esistente, consigliamo prima di effettuare la richiesta Dettaglio Modello e inserire qui il JSON restituito nella proprietà exampleSendPayload
\nIl contentMessage (nei parameters) può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario. Il placeholder va specificato con la sintassi ${nome proprietà}
\nNel caso il contentMessage contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:
\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]
\ncontentMessage = ....\"parameters\": [{\"type\": \"text\",\"text\": \"${nome}\"}]....
\nPer le specifiche del JSON, fare riferimento a https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages
\n"},{"key":"fallbackSms","value":"true","type":"text","description":"[boolean] (Obbligatorio)
\nTrue se si vuole abilitare il fallback sms
\n"},{"key":"fromSms","value":"SMS_SENDER","type":"text","description":"[String] (Opzionale)
\nIl mittente dell'SMS di fallback.
\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.
\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.
\nI mittenti non verificati verranno rimpiazzati con un mittente numerico casuale.
\n"},{"key":"textSms","value":"SMS CONTENT","type":"text","description":"[String] (Opzionale)
\nObbligatorio se fallbackSms è true.
\nTesto del messaggio sms di fallback.
\nSe il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 7.\nAlcuni caratteri estesi occupano 2 caratteri. Nel caso di SMS che sforino la lunghezza standard di 160 caratteri solo a causa di alcuni caratteri estesi, questi saranno rimpiazzati con caratteri semplici mantendo il costo a 1 SMS invece che 2.
\nIl testo può contenere dei placeholder che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi ${nome proprietà}\nNel caso il testo contenga dei placeholder il campo to deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.
\nAd esempio:\nto=[{msisdn:'393481234567',nome:'Mario Rossi'},{msisdn:'393481234568',nome:'Luigi Bianchi'}]\ntext=Invio sms di test a ${nome}
\n"},{"key":"transactionId","value":"","type":"text","description":"[String] (Opzionale)
\nUn identificatore personale dell'invio.
\nConsente di assegnare a tutti i messaggi inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. Massimo 60 caratteri.
\n","disabled":true},{"key":"statusCallback","value":"","type":"text","description":"[String] (Opzionale)
\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) del messaggio.
\n","disabled":true},{"key":"encoding","value":"","type":"text","description":"[String] (Opzionale)
\nL'encoding da utilizzare per il testo del messaggio.
\nI possibili valori sono:
\nDefault : 7BIT
\n","disabled":true},{"key":"sandbox","value":"","type":"text","description":"[String] (Opzionale)
\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.
\nPossibili valori true/false
\n","disabled":true}]},"url":"{{BaseUrl}}/rest/api/wa/message/sendbulk","description":"Modalità di invio sms asincrono da utilizzare con un numero elevato di destinatari (Più di 10 destinatari per singola richiesta).
\nUna volta inviata la richiesta viene restituito un transactionId utile a identificare sucessivamente i messaggi.
\nNel caso l'invio non possa essere completato a causa di un errore verrà inviata un'email contentente il codice di errore.
\nNota: Se invii fino a 10 destinatari per singola richiesta ti consigliamo di utilizzare la funzione di Invio Whatsapp
\n\n\n\n\nSe vuoi inviare un template esistente, dovrai inserire nel parametro ContentMessage un JSON formattato come quello ottenuto nella proprietà exampleSendPayload della funzione Dettaglio Modello
\n
\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Opzionale) -> valorizzare almeno uno tra i parametri id o transactionId
id interno del messaggio inviato.\nÈ possibile specificare più id separandoli con il carattere virgola \",\".
Ad esempio:\n12312 oppure 432432,543543,435435
\n"},{"key":"transactionId","value":"","type":"text","description":"[String] (Opzionale) -> valorizzare almeno uno tra i parametri id o transactionId
transactionId assegnato all'invio
Annulla l'invio di un messaggio non ancora inviato (invio differito).
\nLa chiamata ritorna la lista dei messaggi annullati.
\nPer il dettaglio delle proprietà di ogni singolo messaggio vedi la Descrizione Risposta della funzione Cerca Whatsapp.
\n","urlObject":{"path":["rest","api","wa","message","cancel"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5f9b652b-f31a-4219-a033-8530cd464209","name":"cancel Whatsapp","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"2692017506","type":"text"},{"key":"transactionId","value":"","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/wa/message/cancel"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 2692017506,\n \"to\": \"393400000000\",\n \"textSms\": \"test messaggio\",\n \"fromSms\": \"#RANDOMNUM#\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2023-10-13T11:46:15+0200\",\n \"dataDifferito\": \"2023-10-25T10:18:42+0200\",\n \"transactionId\": \"7aa8fd1f030daa16282a36fd0c194a2e\",\n \"price\": 0.04,\n \"phoneNumberId\": 3,\n \"contentMessage\": \"{\\\"messaging_product\\\":\\\"whatsapp\\\",\\\"recipient_type\\\":\\\"individual\\\",\\\"to\\\":\\\"{{msgeditor_whatsapp_message_to}}\\\",\\\"type\\\":\\\"text\\\",\\\"text\\\":{\\\"body\\\":\\\"Ops, non ho capito\\\",\\\"preview_url\\\":false}}\",\n \"sentAs\": \"unknown\"\n }\n]"}],"_postman_id":"fe1069ff-9b16-4205-ae8a-b203115e43e0"},{"name":"Cerca Whatsapp Ricevuti","id":"a14ab3f7-5f35-4feb-b8d2-5deeff77f142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/wa/message/received/search?offset=0&limit=10&numberId=1&from=393400000000&fromDate=2023-10-01T08:00:00%2B0100&toDate=2025-01-01T08:00:00%2B0100&transactionId=123456","description":"Ricerca dei messaggi whatsapp ricevuti.
\n[Number] (Opzionale)\nPosizione del primo risultato che verrà restituito. Vedi paginazione.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Opzionale)\nNumero massimo di risultati che verranno restituiti. Vedi paginazione.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"[Integer] (Obbligatorio)\nId del numero a cui si vuole associare il nuovo template
\n","type":"text/plain"},"key":"numberId","value":"1"},{"description":{"content":"[String] (Opzionale)\nMittente degli sms ricevuti.\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare più numeri di telefono separandoli con il carattere virgola \",\".\nAd esempio:\n393481234567 oppure 393481234567,393481234568,393481234568
\n","type":"text/plain"},"key":"from","value":"393400000000"},{"description":{"content":"[String] (Opzionale)\nData dalla quale gli sms sono stati ricevuti in formato yyyy-MM-ddTHH:mm:ssZ\nIl carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
\n","type":"text/plain"},"key":"fromDate","value":"2023-10-01T08:00:00%2B0100"},{"description":{"content":"[String] (Opzionale)\nData limite quale gli sms sono stati ricevuti in formato yyyy-MM-ddTHH:mm:ssZ\nIl carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
\n","type":"text/plain"},"key":"toDate","value":"2025-01-01T08:00:00%2B0100"},{"key":"transactionId","value":"123456"}],"variable":[]}},"response":[{"id":"49724ccd-3c1a-426a-a7d6-d1dedfeb05f5","name":"Cerca Whatsapp Ricevuti","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseUrl}}/rest/api/wa/message/received/search?offset=0&limit=10&numberId=1&from=393400000000&fromDate=2023-10-01T08:00:00%2B0100&toDate=2025-01-01T08:00:00%2B0100&transactionId=123456","host":["{{BaseUrl}}"],"path":["rest","api","wa","message","received","search"],"query":[{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\nPosizione del primo risultato che verrà restituito. Vedi [paginazione](#gestire-la-risposta)."},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\nNumero massimo di risultati che verranno restituiti. Vedi [paginazione](#gestire-la-risposta)."},{"key":"numberId","value":"1","description":"[Integer] *(Obbligatorio)*\nId del numero a cui si vuole associare il nuovo template"},{"key":"from","value":"393400000000","description":"[String] _(Opzionale)_\nMittente degli sms ricevuti.\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare _più numeri di telefono_ separandoli con il carattere virgola \",\".\nAd esempio:\n**393481234567** oppure **393481234567,393481234568,393481234568**"},{"key":"fromDate","value":"2023-10-01T08:00:00%2B0100","description":"[String] _(Opzionale)_\nData dalla quale gli sms sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)"},{"key":"toDate","value":"2025-01-01T08:00:00%2B0100","description":"[String] _(Opzionale)_\nData limite quale gli sms sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)"},{"key":"transactionId","value":"123456"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 10\n },\n \"waList\": [\n {\n \"numberId\": 1,\n \"contactId\": 12345,\n \"from\": \"393400000000\",\n \"content\": \"{...jsoncontent...}\",\n \"receiveDate\": \"2023-11-21T08:22:49+0100\"\n },\n {\n \"numberId\": 1,\n \"contactId\": 12345,\n \"from\": \"393400000000\",\n \"content\": \"{...jsoncontent...}\",\n \"receiveDate\": \"2023-11-21T08:22:41+0100\"\n }\n ]\n}"}],"_postman_id":"a14ab3f7-5f35-4feb-b8d2-5deeff77f142"}],"id":"2720bff3-00e0-413a-83d2-9e6dd9841756","_postman_id":"2720bff3-00e0-413a-83d2-9e6dd9841756","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Gestione Modelli Whatsapp","item":[{"name":"Lista Modelli","id":"9a001f38-5361-4330-90ca-27e9f189eb8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/wa/template/list","description":"Visualizza la lista di tutti i modelli whatsapp creati dall'utente tramite interfaccia web.
\nLa risposta contiene un JSON contenente una lista di template , ognuno con le seguenti proprietà:
Restituisce il dettaglio di un singolo modello whatsapp.
\n[Integer] (Obbligatorio)\nId del numero a cui si vuole associare il nuovo template
\n","type":"text"},{"key":"contentSchema","value":"{...JSON_CONTENT...}","description":"[String] (Obbligatorio)\nJSON rappresentante il modello Whatsapp generato dall' embedded editor.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/create","description":"Crea un modello in piattaforma.
\n[Integer] (Obbligatorio)\nId del numero a cui si vuole associare il nuovo template
\n","type":"text"},{"key":"contentSchema","value":"{...JSON_CONTENT...}","description":"[String] (Obbligatorio)\nJSON rappresentante il modello Whatsapp generato dall' embedded editor.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/:templateID","description":"Modifica un modello in piattaforma.
\n[Integer] (Obbligatorio)\nId del modello da modificare
\n","type":"text/plain"},"type":"any","value":"1234","key":"templateID"}]}},"response":[{"id":"5eba62b5-b482-4a39-b9da-81ded99ccbfe","name":"Edit Template","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"numberId","value":"1","description":"[String] *(Obbligatorio)*\nId del numero a cui si vuole associare il nuovo template","type":"text"},{"key":"contentSchema","value":"{\"modified\":\"2025-01-15T11:21:25.569Z\",\"config\":{\"name\":\"template_name\",\"language\":\"it\",\"category\":\"MARKETING\",\"previewTemplateMessageComponents\":[],\"headerMedia\":{\"format\":\"\",\"url\":\"\",\"placeholder\":\"{{msgeditor_header_media_url}}\"}},\"contentMessage\":{\"name\":\"template_name\",\"language\":\"it\",\"category\":\"MARKETING\",\"components\":[{\"type\":\"HEADER\",\"format\":\"TEXT\",\"text\":\"template_header\"},{\"type\":\"BODY\",\"text\":\"template_body\"},{\"type\":\"FOOTER\",\"text\":\"template_footer\"}]}}","description":"[String] *(Obbligatorio)*\nJSON rappresentante il modello Whatsapp generato dall' embedded editor.","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/wa/template/:templateID","host":["{{BaseUrl}}"],"path":["rest","api","wa","template",":templateID"],"variable":[{"key":"templateID","value":"1234","description":"[Integer] *(Obbligatorio)*\nId del modello da modificare"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"templateDetail\": {\n \"id\": 1234,\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\",\n \"status\": \"PENDING\",\n \"numberIds\": [\n 3\n ],\n \"contentMessage\": {\n \"components\": [\n {\n \"format\": \"TEXT\",\n \"text\": \"template_header\",\n \"type\": \"HEADER\"\n },\n {\n \"text\": \"template_body\",\n \"type\": \"BODY\"\n },\n {\n \"text\": \"template_footer\",\n \"type\": \"FOOTER\"\n }\n ],\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\"\n },\n \"contentSchema\": {\n \"contentMessage\": {\n \"components\": [\n {\n \"format\": \"TEXT\",\n \"text\": \"template_header\",\n \"type\": \"HEADER\"\n },\n {\n \"text\": \"template_body\",\n \"type\": \"BODY\"\n },\n {\n \"text\": \"template_footer\",\n \"type\": \"FOOTER\"\n }\n ],\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\"\n },\n \"modified\": \"2025-01-15T11:21:25.569Z\",\n \"config\": {\n \"previewTemplateMessageComponents\": [],\n \"headerMedia\": {\n \"format\": \"\",\n \"placeholder\": \"{{msgeditor_header_media_url}}\",\n \"url\": \"\"\n },\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\"\n }\n },\n \"insertDate\": \"2025-01-15T12:23:01+0100\",\n \"updateDate\": \"2025-01-15T12:23:01+0100\",\n \"exampleSendPayload\": {\n \"template\": {\n \"components\": [],\n \"namespace\": \"\",\n \"name\": \"template_name\",\n \"language\": {\n \"code\": \"it\",\n \"policy\": \"deterministic\"\n }\n },\n \"type\": \"template\"\n }\n }\n}"}],"_postman_id":"ac1e21f9-8817-4995-8105-8019dd7ff17b"},{"name":"Elimina Modello","id":"03d771b3-1404-4db2-b7ac-0984b80b3bad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{BaseUrl}}/rest/api/wa/template/:templateID","description":"Elimina un modello in piattaforma.
\n[Integer] (Obbligatorio)\nId del modello da modificare
\n","type":"text/plain"},"type":"any","value":"1234","key":"templateID"}]}},"response":[{"id":"58489cde-c826-4cd6-8246-cecad422982c","name":"Delete Template","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{BaseUrl}}/rest/api/wa/template/:templateID","host":["{{BaseUrl}}"],"path":["rest","api","wa","template",":templateID"],"variable":[{"key":"templateID","value":"1234","description":"[Integer] *(Obbligatorio)*\nId del modello da modificare"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"03d771b3-1404-4db2-b7ac-0984b80b3bad"},{"name":"Sincronizza Template su Meta","id":"9811964b-13eb-4a31-82c7-fbe909f3b52d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Obbligatorio)\nURL da richiamare con il risultato della sincronizzazione del template
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/sync/:templateId","description":"Sincronizza un template su Meta
\nUna volta finita la sincronizzazione del template, verrà inviato all' URL indicato il dettaglio aggiornato del Modello.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","wa","template","sync",":templateId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Integer] (Obbligatorio)\nId del modello da sincronizzare
\n","type":"text/plain"},"type":"any","value":"1234","key":"templateId"}]}},"response":[{"id":"18b9bf99-70d5-4cea-b968-94e4b9e0c253","name":"Sincronizza Template su Meta","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] *(Obbligatorio)*\nURL da richiamare con il risultato della sincronizzazione del template","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/wa/template/sync/:templateId","host":["{{BaseUrl}}"],"path":["rest","api","wa","template","sync",":templateId"],"variable":[{"key":"templateId","value":"1234","description":"[Integer] *(Obbligatorio)*\nId del modello da sincronizzare"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9811964b-13eb-4a31-82c7-fbe909f3b52d"},{"name":"Sincronizza tutti i Template su Meta","id":"63a35703-fedc-45b1-87ca-1c075e10dd32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Obbligatorio)\nURL da richiamare con il risultato della sincronizzazione del template
\n","type":"text"},{"key":"numberId","value":"1","description":"[Integer] (Opzionale)\nNumero Whatsapp di cui si vogliono sincronizzare i template
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/sync/all","description":"Sincronizza con Meta tutti i modelli.
\nUna volta finita la sincronizzazione del template, verrà inviato all' URL indicato la lista dei modelli aggiornata.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}},"urlObject":{"path":["rest","api","wa","template","sync","all"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"074d3e62-eb98-413d-bb11-06fc2f26b739","name":"Sincronizza tutti i Template su Meta","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] *(Obbligatorio)*\nURL da richiamare con il risultato della sincronizzazione del template","type":"text"},{"key":"numberId","value":"1","description":"[Integer] *(Opzionale)*\nNumero Whatsapp di cui si vogliono sincronizzare i template","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/sync/all"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"63a35703-fedc-45b1-87ca-1c075e10dd32"}],"id":"86e1a102-e87a-4e79-bb98-378e84ed5cd6","_postman_id":"86e1a102-e87a-4e79-bb98-378e84ed5cd6","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"SSO","item":[{"name":"Nuovo Token","id":"270c1168-14ca-4068-a599-eaf4fd86d469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{BaseUrl}}/rest/api/sso/token","description":"Crea un nuovo token per l'accesso alla piattaforma.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
Grazie a queste API è possibile accedere alla piattaforma tramite un token temporaneo.
\n\n\n","_postman_id":"cf511ea3-4247-4a1d-8498-28605757fee7","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Blacklist","item":[{"name":"Aggiungi contatto a blacklist","id":"8170a7f4-cf5d-49a8-a88f-9274326aeb6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"sms","value":"true","description":"Per poter utilizzare le SSO API è necessario richiedere la specifica abilitazione.
\n
Richiedila qui
[Boolean] (Obbligatorio)
\nInserisci contatto nella Blacklist SMS
\n","type":"text"},{"key":"email","value":"false","description":"[Boolean] (Obbligatorio)
\nInserisci contatto nella Blacklist Email
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId","description":"Aggiunge o toglie il contatto indicato dalla blacklist SMS ed Email dell' utente.
\n\n\nIl \"Content-Type\" per questa richiesta POST deve essere \"application/x-www-form-urlencoded\"
\n
[Number] (Obbligatorio)
\nID del contatto da inserire in Blacklist
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"aec8feea-105a-44d5-930e-3a0801b8ac6a","name":"Aggiungi contatto a blacklist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"sms","value":"true","description":"[Boolean] *(Obbligatorio)*\n\nInserisci contatto nella Blacklist SMS","type":"text"},{"key":"email","value":"false","description":"[Boolean] *(Obbligatorio)*\n\nInserisci contatto nella Blacklist Email","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId/add","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","contact",":contactId","add"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nID del contatto da inserire in Blacklist"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:54:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"blacklistSms\": \"INSERTED\",\n \"blacklistEmail\": \"NOT_INSERTED\"\n}"}],"_postman_id":"8170a7f4-cf5d-49a8-a88f-9274326aeb6c"},{"name":"Contatto in blacklist","id":"eae9c1fc-c273-43ee-ab44-fd36a89f5b6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId","description":"Indica se il contatto inserito è presente nella Blacklist SMS ed Email dell' utente.
\n[Number] (Obbligatorio)
\nID del contatto da inserire in Blacklist
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"443b9029-9ad1-4780-9779-261bfe17f1b3","name":"Contatto in blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","contact",":contactId"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nID del contatto da inserire in Blacklist"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:55:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"blacklistSms\": \"INSERTED\",\n \"blacklistEmail\": \"NOT_INSERTED\"\n}"}],"_postman_id":"eae9c1fc-c273-43ee-ab44-fd36a89f5b6a"},{"name":"Lista Msisdn Blacklist","id":"f7eab2fb-f52a-449c-97e9-28f9f27a551d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/blacklist/msisdn/list","description":"Ritorna la lista di numeri di telefono presenti nella Blacklist SMS
\n[String] (Opzionale)\nNumero di cellulare del contatto.\nIl numero di cellulare deve essere comprensivo del prefisso internazionale es. 393480000000
\n","type":"text/plain"},"key":"msisdn","value":"393400000000"},{"disabled":true,"description":{"content":"[String] (Opzionale)\nCerca gli sms stati inviati da questa data (formato yyyy-MM-ddTHH:mm:ssZ)\nIl carattere Z indica il timezone nel formato RFC822 4-digit. \nPer l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno.
\n","type":"text/plain"},"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nPosizione del primo risultato che verrà restituito.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nNumero di risultati che verranno restituiti.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"f0621efc-a8e4-484c-bcf4-694ec7702b47","name":"Get MSISDN Blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/msisdn/list?limit=10&fromDate=2022-03-07T00:00:00%2b0100","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","msisdn","list"],"query":[{"key":"limit","value":"10"},{"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:55:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 50\n },\n \"blacklist\": [\n {\n \"entity\": \"393400000111\",\n \"insertDate\": \"2022-07-11T08:22:02+0200\"\n }\n ]\n}"}],"_postman_id":"f7eab2fb-f52a-449c-97e9-28f9f27a551d"},{"name":"Lista Email Blacklist","id":"00eab2ef-4986-4146-9b8b-4eb61048b9af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/blacklist/email/list","description":"Ricevi la lista di email presenti nella tua Blacklist Email
\n[String] (Opzionale)\nEmail da controllare
\n","type":"text/plain"},"key":"email","value":"testblacklist@fake.it"},{"disabled":true,"description":{"content":"[String] (Opzionale)\nCerca gli sms stati inviati da questa data (formato yyyy-MM-ddTHH:mm:ssZ)\nIl carattere Z indica il timezone nel formato RFC822 4-digit. \nPer l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno.
\n","type":"text/plain"},"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nPosizione del primo risultato che verrà restituito.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Opzionale)\nNumero di risultati che verranno restituiti.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"f19623aa-483c-4fee-8d93-d6e08a4fda82","name":"Get Email Blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/email/list?limit=10&fromDate=2022-03-07T00:00:00%2b0100","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","email","list"],"query":[{"key":"limit","value":"10"},{"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:55:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 50\n },\n \"blacklist\": [\n {\n \"entity\": \"testblacklist@fake.it\",\n \"insertDate\": \"2022-07-11T08:22:02+0200\"\n }\n ]\n}"}],"_postman_id":"00eab2ef-4986-4146-9b8b-4eb61048b9af"}],"id":"e1a16a7d-0bed-4b79-9a33-a28c901e9e6d","description":"Queste chiamate permettono di controllare se un contatto ha numero o email in blacklist, oppure permettono di richiedere la lista delle entità presenti sulla blacklist SMS o Email
\n","_postman_id":"e1a16a7d-0bed-4b79-9a33-a28c901e9e6d","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","id":"d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0","name":"Smshosting REST API","type":"collection"}}},{"name":"Webhook","item":[{"name":"Status Callback","id":"b664255f-a4c8-4afc-ab0f-8c151bc9fd4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"12345678","description":"[String]
\nId interno del messaggio inviato
\n","type":"text"},{"key":"transactionId","value":"a1b2c3d4e5f6","description":"[String]
\nIdentificatore personale dell'invio.
\n","type":"text"},{"key":"to","value":"3480000000","description":"[String]
\nIl destinatario del messaggio.
\n","type":"text"},{"key":"channel","value":"SMS","description":"[String]
\nIl canale del messaggio nello stato attuale.\nQuesto parametro può essere valorizzato con:
\nsms - Il messaggio è nel canale SMS rcs - Il messaggio è nel canale RCSwhatsapp - Il messaggio è nel canale Whatsapp[String]
\nLo stato del messaggio.
\nQuesto parametro sarà valorizzato con:
\nDELIVERED - SMS consegnato NOTDELIVERED - SMS non consegnabile[String]
\nData in cui il messaggio ha cambiato stato (url encoded in formato yyyy-MM-ddTHH:mm:ssZ) .
\nIl carattere Z indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).
\nAd esempio:
\n2014-12-25T08:00:00+0200 indica il 25/12/2014 alle 08:00:00 riferito al GMT +2
\n","type":"text"}]},"url":"https://tuodominio.com/tuo-percorso-callback","description":"Se durante l'invio è stato valorizzato il parametro statusCallback, il nostro server farà una chiamata POST all'url che hai specificato per notificarti lo stato dell'invio.
Se non vuoi gestire la Status Callback puoi in ogni momento interrogare lo stato di uno o più messaggi inviati con la funzione \"cerca\" del canale utilizzato.
\n\n\nIl \"Content-Type\" di questa chiamata POST sarà \"application/x-www-form-urlencoded\"
\n
Il nostro server accetterà questi codici di risposta alla chiamata fatta verso il tuo url:
\n","urlObject":{"protocol":"https","path":["tuo-percorso-callback"],"host":["tuodominio","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b664255f-a4c8-4afc-ab0f-8c151bc9fd4b"},{"name":"Send Bulk Callback","id":"0a830195-f1f9-499b-89a1-c85b83ae4b61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://tuodominio.com/tuo-percorso-bulk-callback","description":"Nell'invio bulk puoi specificare un URL con il parametro transactionCallback.
Verso tale URL il nostro server effettuarà delle chiamate per notificare l'esito dell'invio una volta che questo si è concluso.
\n\n\nIl \"Content-Type\" di questa chiamata POST sarà \"application/json\"
\n
Il nostro server accetterà questi codici di risposta alla chiamata fatta verso il tuo url
\n{\"status\": \"ERROR\", \"errorMsg\": \"NO_CREDIT\", \"transactionId\": \"a1b2c3d4e5f6\"}\n\n{\n \"status\": \"COMPLETED\",\n \"from\": \"TestSender\",\n \"text\": \"Invio di TEST\",\n \"transactionId\": \"a1b2c3d4e5f6\",\n \"smsInserted\": 1,\n \"smsNotInserted\": 0,\n \"sms\":[\n {\n \"to\":\"39340000000\",\n \"status\":\"INSERTED\",\n \"id\":12345678\n }\n ]\n}\n\n