Multidialogo > PER SVILUPPATORI

Le funzioni per gli sviluppatori

Ai fine di consentire l'integrazione delle funzionalità di Multidialogo all'interno di altre applicazioni come il tuo sito web o il gestionale dela tua azienda, lo staff tecnico ha sviluppato alcuni utili servizi ed interfacce di programmazione di facile utilizzo ed elevata flessibilità.

Documentazione:

Per utilizzare i servizi è necessario possedere un account su Multidialogo ed avere attivato il modulo necessario per accedere alle funzionalità del servizio richiesto. L'integrazione di Multidialogo è basata su una semplice richiesta http e passaggio di parametri tramite metodo get o post. Di seguito è riportato l'elenco delle azioni disponibili e dei parametri richiesti, oltre che esempi di utilizzo e codice da copiare pronto all'uso.

- Developer
NEW!
Url - Endpoint:
http://go.multidialogo.it/api/index.php(indirizzo IP del tuo multidialogo)
Method:
POST, GET
Parametri:
global:
iomode
=>
'json'|'phpserial'|'jsonp'
tipo: string - desc: Metodo di codifica input/output.
action
=>
'sendsms'|'sendfax'|'sendposta'|'sendemail'|'sendshare'|'set'|'get'|'getall'|'del'|'report'|'report_list'|'charge'|'list_az_cat'
tipo: string - desc: Operazione richiesta.
authentication:
auth[user]
=>
'myusername'
tipo: string - desc: Username di accesso a Multidialogo.
auth[pass]
=>
'34819d7beeabb9260a5c854bc85b3e44'
tipo: string - desc: Password di accesso a Multidialogo codificata in md5.
auth[su]
=>
'username'
tipo: string - desc: Username utente da impersonificare per rivenditori e licenze master.
RIEPILOGO SUPPORTO OPERAZIONI API CON SU:
- sendsms, sendfax, sendposta, [SI, se master]
- sendemail, sendshare [NO]
- set [NO]
- get [SOLO SU OGGETTO USER, per recuperare informazioni relative all'account quali configurazioni, credito e condivisioni]
- report [SI]
- charge [NO]
- list_az_cat [NO]
- report_list [SI]
- optional
common:
callback
=>
'callback'
tipo: string - desc: Nome funzione di callback in caso di utilizzo di jasonp come metodo di codifica input/output. - optional
memo
=>
'promemoria'
tipo: string - desc: Promemoria operazione. - optional
msg
=>
'messaggio di test'
tipo: string - desc: Messaggio sms, prima pagina fax. - optional
delivery_time
=>
'2010-08-15 08:00:00'
tipo: string - desc: Data di consegna per invii. Formato yyyy-mm-dd hh:mm:ss - optional
notify_email
=>
'info@netbuilder.it'
tipo: string - desc: Indirizzo email di notifica operazione sendposta. - optional
sender
=>
'nome mittente'
tipo: string - desc: Nome o numero mittente posta, sms, fax. - optional
custom
=>
      [
        {
          "nome":'nomecampo', (string) nome campo
          "valore":'valorecampo', (string) valore
          "hidden":false, (bool) indica se il campo è nascosto in visualizzazione sulla piattaforma
        }
      ]
tipo: array - desc: Campi personalizzati per operazioni di invio sms, fax, posta ('sendsms','sendfax','sendposta'). - optional
client
=>
'mioclient'
tipo: string - desc: Identificativo Client utilizzato per le chiamate sendsms, sendfax, sendposta e sendemail. Per tutte le altre chiamate il parametro verrà ignorato. - optional
files:
$_FILES
=>
tipo: array - desc: Array associativo item uploadati tramite il metodo HTTP POST. - optional
filesdata
=>
tipo: base64Binary - desc: Concatenazione encoding in base 64 dei file allegati da spedire.
Aggiunto supporto per metodi sendemail e sendshare.
Parametro presente per retrocompatibilità, ma sostituito dal più recente e strutturato parametro files.
- optional
filesnames
=>
tipo: string - desc: Stringa contenente i nomi dei file separati da virgola nello stesso ordine.
Aggiunto supporto per metodi sendemail e sendshare.
Parametro presente per retrocompatibilità, ma sostituito dal più recente e strutturato parametro files.
- optional
filesizes
=>
tipo: string - desc: Stringa contenente le dimensioni dei file in Byte separate da virgola nello stesso ordine.
Aggiunto supporto per metodi sendemail e sendshare.
Parametro presente per retrocompatibilità, ma sostituito dal più recente e strutturato parametro files.
- optional
files
=>
      [
        {
          "name":"filename.pdf", (string) nome del file
          "size":7097, (int) dimensione del file in byte
          "data":""  (base64Binary) contenuto del file codificato in base64
          "delta":null  (int) numero pagine per destinatario in caso di Posta Unica, altrimenti null.
        }
      ]
tipo: array - desc: File da spedire in caso di posta, fax , email, condivisioni. L'utilizzo di questo parametro è alternativo agli altri parametri per inviare file. E' possibile inserire un array di elementi. - optional
destination:
dest_options[create]
=>
'true'
tipo: boolean - desc: Indica se creare, aggiornare dati destinatari. - optional
dest_options[limit]
=>
'100'
tipo: integer - desc: Numero massimo destinatari. - optional
dest_str
=>
'+393331234567<pippo>,+393337654321'
tipo: string - desc: Stringa numeri cellulari o fax in formato internazionale separati da virgola.Stringa indirizzi email separati da virgola in caso di sendemail o sendshare.Possibilità di specificare una label/nome fra parentesi acute da associare al numero. - optional
destination array:
dest[i][objtype]
=>
'AZIENDA'|'CONTATTO'|'USER'|'CONTATTO_AZ'
tipo: string - desc: Indica tipo destinatario azione di riferimento.Obbligatorio in caso di chiamata metodo set o get nonchè in caso di parametro dest_options[create]=true. Il tipo CONTATTO_AZ non è disponibile per le operazioni di invio, ma solo per le azioni get e set. - optional
dest[i][id]
=>
'null'
tipo: integer - desc: Indica identificativo Multidialogo destinatario. - optional
dest[i][unique]
=>
'null'
tipo: string - desc: Indica identificativo univoco custom destinatario. - optional
dest[i][parent_id]
=>
'null'
tipo: integer - desc: Indica identificativo Multidialogo azienda padre in caso objtype sia uguale a CONTATTO_AZ. - optional
dest[i][parent_unique]
=>
'null'
tipo: string - desc: Indica identificativo univoco custom azienda padre in caso objtype sia uguale a CONTATTO_AZ. - optional
dest[i][codice]
=>
'00001'
tipo: string - desc: Codice Azienda. - optional
dest[i][condivisa]
=>
'false'
tipo: boolean - desc: Indica se si tratta di un Azienda condivisa. - optional
dest[i][ragionesociale]
=>
'Netbuilder srl'
tipo: string - desc: Ragionesociale/Denominazione destinatario. - optional
dest[i][nome]
=>
'nome'
tipo: string - desc: Nome destinatario. - optional
dest[i][cognome]
=>
'cognome'
tipo: string - desc: Cognome destinatario. - optional
dest[i][soprannome]
=>
'pippo'
tipo: string - desc: Soprannome Contatto. - optional
dest[i][cf]
=>
'ntbldr12m34d567a'
tipo: string - desc: Codice Fiscale destinatario. - optional
dest[i][piva]
=>
'12345678912'
tipo: string - desc: Partita Iva destinatario. - optional
dest[i][comune]
=>
'Parma'
tipo: string - desc: Comune destinatario (codice istat o descrizione). - optional
dest[i][prov]
=>
'Parma'
tipo: string - desc: Provincia destinatario (codice istat o descrizione). - optional
dest[i][regione]
=>
'Emilia-Romagna'
tipo: string - desc: Regione destinatario (codice istat o descrizione). - optional
dest[i][nazione]
=>
'Italy'
tipo: string - desc: Nazione destinatario (codice istat o descrizione). - optional
dest[i][localita]
=>
''
tipo: string - desc: Descrizione località destinatario - optional
dest[i][indirizzo]
=>
'via zarotto 63'
tipo: string - desc: Indirizzo destinatario. - optional
dest[i][cap]
=>
'43100'
tipo: string - desc: Cap destinatario. - optional
dest[i][web]
=>
'http://www.netbuilder.it'
tipo: string - desc: Sito web destinatario. - optional
dest[i][telefono]
=>
'0521247791'
tipo: string - desc: Telefono destanatario - optional
dest[i][telefono2]
=>
''
tipo: string - desc: Telefono secondario destinatario. - optional
dest[i][cellulare]
=>
'3331234567'
tipo: string - desc: Cellulare destinatario. - optional
dest[i][fax]
=>
'05217431140'
tipo: string - desc: Fax destinatario. - optional
dest[i][email]
=>
'info@netbuilder.it'
tipo: string - desc: Indirizzo email destinatario. - optional
dest[i][dipendenti]
=>
1
tipo: integer - desc: Numero dipendenti azienda - optional
dest[i][soci]
=>
3
tipo: integer - desc: Numero soci azienda. - optional
dest[i][collaboratori]
=>
5
tipo: integer - desc: Numero collaboratori azienda - optional
dest[i][fatturato]
=>
300000
tipo: float - desc: Fatturato azienda. - optional
dest[i][note]
=>
'bla bla bla...'
tipo: string - desc: Note destinatario. - optional
dest[i][deny_newsletter]
=>
1|0
tipo: integer - desc: Dissenso newsletter. Inserire 1 per negare l'invio newsletter verso questo account. - optional
dest[i][date_change_nl]
=>
2012-12-21
tipo: date - desc: Inserire la data dell'ultimo consenso/dissenso newsletter in accordo con il parametro 'deny_newsletter'.Formato yyyy-mm-dd. - optional
dest[0][cat]
=>
      [
        {
          "id":1, (int) identificativo ruolo
          "nome":'categoria1', (string) descrizione ruolo
        }
      ]
tipo: array - desc: Categorie per aziende (objtype = AZIENDA) o gruppi per contatti rubriche (objtype = CONTATTO). In caso l'id non sia presente ed il nome sia valorizzato, verrà inserita una nuova categoria azienda fra quelle disponibili. - optional
dest[0][ruoli]
=>
      [
        {
          "id":1, (int) identificativo ruolo
          "descrizione":'ruolo1', (string) descrizione ruolo
        }
      ]
tipo: array - desc: Ruoli per contatti aziende (objtype = CONTATTO_AZ). Id o descrizione devono obbligatoriamente coincidere con i valori presenti su Multidialogo. - optional
dest[0][custom]
=>
      [
        {
          "nome":'nomecampo', (string) nome campo
          "valore":'valorecampo', (string) valore
          "hidden":false, (bool) indica se il campo è nascosto in visualizzazione sulla piattaforma
        }
      ]
tipo: array - desc: Campi personalizzati per destinatari. - optional
dest[i][userdata]
=>
array('nome1'=>'val1','nome2'=>'val2')
tipo: array - desc: Dati personalizzati (non corrispondenti a dati reali su Multidialogo). - optional
sendposta:
posta_options[mode]
=>
'NORMAL'|'ARCHIVE'|'UNIQUE'
tipo: string - desc: Scegliere la tipologia di posta desiderata fra posta normale, posta archivio e posta unica.Default 'Normal'. - optional
posta_options[optimizes_postage]
=>
'true'|'false'
tipo: boolean - desc: Se 'true' indica al sistema di ottimizzare le spese di affrancatura utilizzando il vettore TNT.Di default (se 'false' o non indicato) il sistema utilizzerà il vettore Poste Italiane.In caso la modalità di consegna scelta sia la posta TARGET il parametro non è disponibile e verrà ignorato! - optional
posta_options[page_mode]
=>
'FRONT'|'BOTH'
tipo: string - desc: Modalità di stampa fronte/fronte-retro. - optional
posta_options[print_color]
=>
'BW'|'COLOR'
tipo: string - desc: Modalità di stampa bianco-nero/colori. - optional
posta_options[delivery_type]
=>
'PRIORITARIA'|'RACCOMANDATA'|'RACCOMANDATAAR'|'TARGET'
tipo: string - desc: Modalità di consegna. Attenzione: la modalità di tipo TARGET richiede la presenza di almeno 1000 destinatari. - optional
posta_options[dest_type]
=>
'RAGSOC'|'NOME'|'BOTH'
tipo: string - desc: Indica solo ragione sociale destinatario, solo nome o tutti e due. - optional
posta_options[deny_logo]
=>
'false'
tipo: boolean - desc: Indica di non utilizzare buste personalizzate per la stampa nel caso l'utente sia abilitato all'utilizzo di buste personalizzate (o direttamente o in quanto ereditato dal proprio master). Il valore di default è 'false' e quindi le buste personalizzate vengono utilizzate automaticamente. In caso l'utente non sia abilitato all'utilizzo di buste personalizzate allora il parametro è ininfluente. - optional
posta_options[logo_type]
=>
'P'|'M'
tipo: string - desc: Parametro opzionale per specificare il tipo di busta personalizzata da utilizzare in caso l'utente sia abilitato sia all'utilizzo della busta personale che ha quella ereditata dal propio master. Indicare 'P' per la busta personale ed 'M' per quella master. Se il parametro non è specificato allora la busta personale vince su quella ereditata. - optional
posta_options[staple]
=>
'false'
tipo: boolean - desc: Parametro opzionale che consente di richiedere la pinzatura del documento da spedire in caso il numero di fogli sia superiore a 1. - optional
posta_options[file_descriptor]
=>
'Param.xml'
tipo: string - desc: Indica il nome del file xml contenuto all'interno dell'archivio zip in caso di posta archivio con file descriptor. Il file descriptor è un file xml contenente le informazioni su allegati e destinatari. Il modello di riferimento per il file descriptor può essere scaricato qui. - optional
posta_options[attach]
=>
      [
        {
          "fr":'SI'|'NO', (string) stampa fronte retro
          "colore":'SI'|'NO', (string) stampa a colori
          "formato":'A4', (string) formato stampa
          "grammatura":'80', (string) grammatura stampa
          "pinzatura":1|0, (smallint) pinzatura stampa
          "file":{
            "name":"filename.pdf", (string) nome del file
            "size":7097, (int) dimensione del file in byte
            "data":""  (base64Binary) contenuto del file codificato in base64
          }
        }
      ]
tipo: array - desc: Inserti in caso di Posta Archivio.Gli inserti saranno inclusi in ogni lettera di ogni destinatario presente nel file ZIP. Gli inserti potranno avere parametri (Colore, B/N, ecc...) personalizzati. - optional
posta_options[attach_in]
=>
      [
        {
          "file":{
            "name":"filename.pdf", (string) nome del file
            "size":7097, (int) dimensione del file in byte
            "data":""  (base64Binary) contenuto del file codificato in base64
          }
        }
      ]
tipo: array - desc: Allegati per Posta Unica. Gli allegati erediteranno i parametri (Colore, B/N, ecc...) impostati per la posta. - optional
posta_options[sender][indirizzo]
=>
'indirizzo mittente'
tipo: string - desc: Indirizzo mittente. - optional
posta_options[sender][cap]
=>
'43100'
tipo: string - desc: Cap mittente. - optional
posta_options[sender][citta]
=>
'Parma'
tipo: string - desc: Città mittente. - optional
posta_options[sender][provincia]
=>
'PR'
tipo: string - desc: Provincia mittente. - optional
posta_options[sender][nazione]
=>
'Italy'
tipo: string - desc: Nazione mittente. - optional
sendfax:
fax_options[sender][fax]
=>
'+390521247791'
tipo: string - desc: Fax mittente. - optional
fax_options[sender][first_page]
=>
'false'
tipo: boolean - desc: Indica se abilitare il sistema ad aggiungere in automatico la prima pagina (copertina) del fax con le informazioni sul mittente ed eventualmente il testo contenuto nel parametro 'msg' (default: false). - optional
sendsms:
sms_type
=>
'report'|'classic'|'basic'
tipo: string - desc: Tipo sms. (obbligatorio in caso utilizzo metodo sendsms) - optional
sendemail:
mail_options[from]
=>
'info@netbuilder.it'
tipo: string - desc: Indirizzo email da utilizzare per il campo from.Se assente il sistema proverà ad utilizzare l'email dell'account autenticato. - optional
mail_options[subject]
=>
'Test mail api md'
tipo: string - desc: Oggetto della mail. - optional
mail_options[body]
=>
'Messaggio di test mail'
tipo: string - desc: Corpo della mail.Testo o html. - optional
sendshare:
share_options[permission]
=>
'R'|'W'|'D'
tipo: string - desc: Permessi da assegnare alla condivisione.È possibile concatenare più opzioni. - optional
share_options[expire]
=>
'2010-08-15 08:00:00'
tipo: string - desc: Data di scadenza condivisione. Formato yyyy-mm-dd hh:mm:ss - optional
share_options[destination]
=>
'PERSONAL'|'SHARED'
tipo: string - desc: Area di destinazione condivisione (documenti personali o condivisi) - optional
share_options[dirname]
=>
'Nuova Cartella'
tipo: string - desc: Nome da assegnare alla nuova cartella condivisa se si desidera crearne una. - optional
share_options[read_certify]
=>
'true'
tipo: boolean - desc: Imposta certificazione di lettura per la condivisione. - optional
share_options[body]
=>
'Messaggio di test mail'
tipo: string - desc: Testo da aggiungere al corpo della mail di condivisione. - optional
get:
get_options[user_config]
=>
'true'
tipo: boolean - desc: Indica se ritornare le impostazioni di configurazione dell'utente (in caso di utilizzo con tipo di destinatario 'USER'). - optional
get_options[user_credit]
=>
'true'
tipo: boolean - desc: Indica se ritornare il credito residuo dell'utente (in caso di utilizzo con tipo di destinatario 'USER'). - optional
get_options[user_shares]
=>
'true'
tipo: boolean - desc: Indica se ritornare le condivisioni attive dell'utente (in caso di utilizzo con tipo di destinatario 'USER'). - optional
get_options[filter_shares]
=>
'info@netbuilder.it'
tipo: string - desc: Possibilità di indicare indirizzo mail per filtrare le condivisioni se 'get_options[user_shares]' è true (in caso di utilizzo con tipo di destinatario 'USER'). - optional
get_options[user_template]
=>
'true'
tipo: boolean - desc: Indica se ritornare i template newsletter disponibili per l'utente (in caso di utilizzo con tipo di destinatario 'USER' ed invio email abilitato) - optional
get_options[commissions]
=>
'true'
tipo: boolean - desc: Indica se ritornare l'elenco delle provvigioni maturate per l'utente (in caso di utilizzo con tipo di destinatario 'USER' e provvigioni abilitate). In assenza di criteri di ricerca verranno restituite le provvigioni maturate nell'anno corrente suddivise per mese e subaccount di riferimento. - optional
get_options[commissions_filters][details]
=>
'true'
tipo: boolean - desc: Indica se ritornare il dettaglio per tipologia delle provvigioni maturate restituite. - optional
get_options[commissions_filters][year]
=>
2013
tipo: integer - desc: Possibilità di indicare l'anno per filtrare le provvigioni restituite. - optional
get_options[commissions_filters][month]
=>
4
tipo: integer - desc: Possibilità di indicare il mese per filtrare le provvigioni restituite (rappresentazione numerica del mese da 1 a 12). - optional
get_options[commissions_filters][username]
=>
'username'
tipo: string - desc: Possibilità di indicare lo username del subaccount di riferimento per filtrare le provvigioni restituite. - optional
get_options[commissions_filters][account_code]
=>
'codice'
tipo: string - desc: Possibilità di indicare il codice del subaccount di riferimento per filtrare le provvigioni restituite. - optional
getall:
getall_options[objtype]
=>
'AZIENDA'|'CONTATTO'|'CONTATTO_AZ'|'AZIENDA_CAT'|'CONTATTO_CAT'|'CONTATTO_AZ_ROLE'
tipo: string - desc: Indica tipo destinatario azione di riferimento. - optional
getall_options[filter][deny_newsletter]
=>
tipo: boolean - desc: Consente di specificare un filtro per il campo consenso newsletter. Se true verranno restituiti tutti i destinatari che hanno negato il consenso all'invio delle newsletter. Se false quelli che hanno acconsentito. Non utilizzare il parametro equivale a non effettuare alcun filtro sull' operazione. - optional
report:
report_options[action]
=>
'sendsms'|'sendfax'|'sendposta'|'sendemail'
tipo: string - desc: Nome operazione per la quale si richiede la reportistica. - optional
report_options[sendcode]
=>
'1234567894324'
tipo: string - desc: Codice invio operazione (identificativo univoco operazione restituito dai metodi sendposta, sendfax, sendsms, sendemail - optional
report_options[dest_details]
=>
'true'
tipo: boolean - desc: Indica se tornare il dettaglio dei destinatari nella reportistica per le operazioni sendsms, sendfax e sendposta. Non supportato per il metodo 'report_list' - optional
report_options[from_date]
=>
'2012-01-01'
tipo: date - desc: Data di partenza filtro per metodo 'report_list'. - optional
report_options[to_date]
=>
'2012-12-31'
tipo: date - desc: Data di fine filtro per metodo 'report_list'. - optional
report_options[status]
=>
A,AP,ACP,ACB,ACC,R,B,E,S,P,C,CP,KO
tipo: string - desc: Filtro stato code per metodo 'report_list'. E' possibile indicare più stati separati da virgola. Non supportato per metodo 'sendemail'. - optional
report_options[get_child]
=>
true|false
tipo: boolean - desc: Possibilità di vedere code utenti figli per rivenditori e licenze master. - optional
report_options[apply_iva]
=>
true|false
tipo: boolean - desc: Indica se applicare l'iva ai costi della coda (Default: true). - optional
Url - Endpoint:
http://go.multidialogo.it/api/index.php(indirizzo IP del tuo multidialogo)
Method:
POST, GET
Parametri:
iomode
=>
json | phpserial
tipo: string - desc: indica il metodo di codifica per il parametro _args e per il valore restituito dalla chiamata - optional (default json)
_args
=>
tipo: Json o Phpserial
description (es: Json):
  • _args = {
    • "iomode" : "json" | "jsonp" | "phpserial",
    • "action" : "sendsms" | "sendfax" | "sendposta" | "sendemail" | "sendshare" | "set" | "get" | "getall" | "del" | "report" | "report_list" | "charge" | "list_az_cat",
    • "auth" : {
      • "user" : "username",
      • "pass" : "34819d7beeabb9260a5c854bc85b3e44",
      • "su" : "opaque",
      },
    • "callback" : "",
    • "memo" : "",
    • "msg" : "",
    • "delivery_time" : "",
    • "sender" : "",
    • "notify_email" : "",
    • "client" : "",
    • "custom" : [
      • {
        • "nome" : "nome1",
        • "valore" : "valore1",
        • "hidden" :
        },
      ]
    • "posta_options" : {
      • "mode" : "NORMAL" | "ARCHIVE" | "UNIQUE",
      • "optimizes_postage" : "true" | "false",
      • "page_mode" : "FRONT" | "BOTH",
      • "print_color" : "BW" | "COLOR",
      • "delivery_type" : "PRIORITARIA" | "RACCOMANDATA" | "RACCOMANDATAAR" | "TARGET",
      • "dest_type" : "RAGSOC" | "NOME" | "BOTH",
      • "deny_logo" : "true" | "false",
      • "logo_type" : "P" | "M",
      • "staple" : "true" | "false",
      • "file_descriptor" : "",
      • "attach" : [
        • {
          • "fr" : "SI" | "NO",
          • "colore" : "SI" | "NO",
          • "formato" : "A4",
          • "grammatura" : "80",
          • "pinzatura" : "1" | "0",
          • "file" : {
            • "name" : "filename.pdf",
            • "size" : "7097",
            • "data" : "",
            }
          },
        ]
      • "attach_in" : [
        • {
          • "file" : {
            • "name" : "filename.pdf",
            • "size" : "7097",
            • "data" : "",
            }
          },
        ]
      • "sender" : {
        • "indirizzo" : "",
        • "cap" : "",
        • "citta" : "",
        • "provincia" : "",
        • "nazione" : "",
        },
      },
    • "fax_options" : {
      • "sender" : {
        • "fax" : "",
        },
      • "first_page" : "true" | "false",
      },
    • "mail_options" : {
      • "from" : "",
      • "subject" : "",
      • "body" : "",
      },
    • "share_options" : {
      • "permission" : "",
      • "expire" : "",
      • "destination" : "",
      • "dirname" : "",
      • "read_certify" : "",
      • "body" : "",
      },
    • "get_options" : {
      • "user_config" : "true" | "false",
      • "user_credit" : "true" | "false",
      • "user_shares" : "true" | "false",
      • "user_template" : "true" | "false",
      • "filter_shares" : "",
      • "commissions" : "true" | "false",
      • "commissions_filters" : {
        • "details" : "true" | "false",
        • "year" :
        • "month" :
        • "username" : "",
        • "account_code" : "",
        },
      },
    • "getall_options" : {
      • "objtype" : "AZIENDA" | "CONTATTO" | "CONTATTO_AZ" | "AZIENDA_CAT" | "CONTATTO_CAT" | "CONTATTO_AZ_ROLE",
      • "filter" : {
        • "deny_newsletter" : "true" | "false",
        },
      },
    • "report_options" : {
      • "action" : "sendsms" | "sendfax" | "sendposta" | "sendemail",
      • "sendcode" : "",
      • "dest_details" : "true" | "false",
      • "from_date" : "2012-01-01",
      • "to_date" : "2012-12-31",
      • "status" : "",
      • "get_child" :
      • "apply_iva" :
      },
    • "charge_options" : {
      • "chargecode" : "E-EURO25" | "E-EURO50" | "E-EURO100" | "E-EURO250" | "E-EURO500" | "E-EURO1000",
      • "pptrid" : "",
      },
    • "filesdata" : "",
    • "filesnames" : "",
    • "filesizes" : "",
    • "files" : [
      • {
        • "name" : "filename.pdf",
        • "size" :
        • "data" : "",
        • "delta" :
        },
      ]
    • "dest_options" : {
      • "create" : "true" | "false",
      • "limit" :
      },
    • "dest_str" : "numero",
    • "dest" : [
      • {
        • "objtype" : "AZIENDA" | "CONTATTO" | "USER" | "CONTATTO_AZ",
        • "id" : "",
        • "unique" : "",
        • "parent_id" : "",
        • "parent_unique" : "",
        • "codice" : "",
        • "condivisa" : "true" | "false",
        • "ragionesociale" : "",
        • "nome" : "",
        • "cognome" : "",
        • "soprannome" : "",
        • "cf" : "",
        • "piva" : "",
        • "comune" : "",
        • "prov" : "",
        • "regione" : "",
        • "nazione" : "",
        • "localita" : "",
        • "indirizzo" : "",
        • "cap" : "",
        • "web" : "",
        • "telefono" : "",
        • "telefono2" : "",
        • "cellulare" : "",
        • "fax" : "",
        • "email" : "",
        • "dipendenti" :
        • "soci" :
        • "collaboratori" :
        • "fatturato" :
        • "note" : "",
        • "deny_newsletter" :
        • "date_change_nl" : "2012-01-31",
        • "cat" : [
          • {
            • "id" : "",
            • "nome" : "",
            }
          ]
        • "ruoli" : [
          • {
            • "id" : "",
            • "descrizione" : "",
            }
          ]
        • "custom" : [
          • {
            • "nome" : "nome1",
            • "valore" : "valore1",
            • "hidden" : "",
            }
          ]
        • "costo" : {
          • "stampa" :
          • "affrancatura" :
          • "inserto" :
          },
        },
      ]
    }
Return:
tipo: Json o Phpserial
description (es: Json):
  • {
    • "status" : "ok" | "error",
    • "param" : {
      • "warnings" : "param error description",
      },
    • "action" : {
      • "codiceinvio" : "sent code",
      • "sendcode" : "sent code",
      • "sent" : "report sent",
      • "sent_error" : "sent error count",
      • "dest_error" : "sent error description",
      • "insert" : "objects insert count",
      • "update" : "objects update count",
      • "creation" : "report creation date",
      • "delivery" : "report delivery time",
      • "memo" : "report memo",
      • "recipient" : "report recipient",
      • "viewed" : "report mail viewed",
      • "traffic" : "report mail traffic",
      • "enable" : "report send enable",
      • "status" : "report send status",
      • "warnings" : "action error description",
      },
    }
Invio Sms: 
Esempio1:
HTML/PHP
Semplice invio con stringa numeri destinatari generica separati da virgola.
Esempio2:
HTML/PHP
Invio con destinatari da contatti rubrica e opzione per creare nuovi contatti se non esistono.
Invio Fax:
Esempio1:
HTML/PHP
Semplice invio con stringa numeri destinatari generica separati da virgola e testo fax manuale.
Esempio2:
HTML/PHP
Invio con destinatari da db aziende e opzione per creare nuove aziende se non esistono.Upload diretto dei file da inviare.
Invio Posta:
Esempio1:
HTML/PHP
Semplice invio con lista destinatari generica (nessun passaggio di id o unique, parametro dest_options[create] false).Upload diretto dei file da inviare.
Esempio2:
HTML/PHP
Invio con lista destinatari presa da db aziende e identificazione aziende tramite parametro unique.Upload diretto dei file da inviare.
Esempio3 - Posta Archivio:
HTML/PHP
Semplice invio posta archivio di tipo prioritaria.
Esempio4 - Posta Unica:
HTML/PHP
Semplice invio posta unica di tipo prioritaria con 2 allegati.
Invio Email:
Esempio1:
HTML/PHP
Semplice invio singola mail a destinatario generico.
Esempio2:
HTML/PHP
Semplice invio mail a 2 aziende già presenti con allegato.
Invio Condivisioni:
Esempio1:
HTML/PHP
Semplice creazione di una cartella condivisa.
Set:
Esempio1:
HTML/PHP
Semplice inserimento/aggiornamento di 2 contatti e 2 aziende.
Get:
Esempio1:
HTML/PHP
Semplice recupero dei dati di un contatto tramite unique.
Esempio2:
HTML/PHP
Semplice recupero dlle informazioni relative al mio account.Recupero impostazioni di configurazione, credito residuo e condivisioni attive verso un indirizzo email specificato in 'get_options[user_shares_filters]'.
Getall:
Esempio1:
HTML/PHP
Ritorno elenco contatti rubrica dell'account che hanno acconsentito l'invio della newsletter.
Return json:

{
  "getall":{
    "dest":
    [
      {
        "objtype":"CONTATTO",
        "id":"...",
        "unique":"...",
        "nome":"...",
        "cognome":"...",
        "soprannome":"...",
        "cf":null,
        "comune":null,
        "prov":null,
        "regione":null,
        "nazione":"it",
        "localita":null,
        "indirizzo":null,
        "cap":null,
        "web":null,
        "telefono":"",
        "cellulare":"",
        "fax":"",
        "email":null,
        "note":null,
        "cat":null,
        "deny_newsletter":0,
        "date_change_nl":null
      },
      ...
    ]
  },
  "status":"ok"
}
Report:
Esempio1:
HTML/PHP
Reportistica operazione sendemail
Return json:
{
  "report":{
    "sendcode":1297424371,
    "creation":"11-feb-2011 12:39",
    "delivery":"11-feb-2011 12:42",
    "memo":"oggetto mail",
    "recipient":"3",
    "sent":"3",
    "viewed":null,
    "traffic":"67KB",
    "enable":1,
    "status":"completed"
  },
  "status":"ok"
}
Esempio2:
HTML/PHP
Reportistica operazione sendfax.
Return json:
{
  "report":{
    "sendcode":"1285171458-256",
    "creation":"22-set-2010 18:04",
    "delivery":"22-set-2010 18:04",
    "memo":"test",
    "recipient":1,
    "sent":"1",
    "enable":1,
    "status":"completed"
  },
  "status":"ok"
}
list_az_cat:
Esempio1:
HTML/PHP
Lista elenco categorie aziende disponibili.
Return json:
{
  "list_az_cat":
    {"categorie":[
      {"id":"1","nome":"categoria1"},
      {"id":"2","nome":"categoria2"},
      ...
      ]
    },
  "status":"ok"
}