Multidialogo > APIS

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:
https://go.multidialogo.it/api/index.php
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'|'get_prices'|
'check_cap'|'get_analytics'
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 e email ('sendsms','sendfax','sendposta','sendemail'). - 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
get_analytics:
get_analytics_options
=>
      [
        {
          "idaccounts":'elenco id master (opzionale)', (array) se non indicato si usano tutti i master del segnalatore
          "indexes":'elenco di indici da ritornare (opzionale)', (array) se non indicato vengono ritornati tutti gli indici
          "year": anno di cui si vogliono i dati (opzionale) (string) se non indicato viene usato l'anno corrente
          "include_childs":'include le cal dei master (opzionale)', (bool) se non indicato é settato a true
        }
      ]
tipo: array - desc: Array che contiene i parametri necessari ad ottenere le analytics (ATTENZIONE solo gli account segnalatore e Admin possono utilizzare questa funzione), per l'elenco completo degli indici cliccare qui - optional
check cap:
check_cap_options
=>
      [
        {
          "custom_id":'id personale (opzionale)', (string) id cliente (viene ritornato nel result)
          "cap":'cap', (string) valore del cap
          "affrancatura": tipo affrancatura, (string) tipo di affrancatura (vedi affrancatura)
          "vector":'vettore', (string) tipo vettore
          "nazione":'nazione', (string) nazione del cap
        }
      ]
tipo: array - desc: Array che contiene i cap da verificare
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]
=>
'https://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[i][sm_enable]
=>
false
tipo: boolean - desc: Indica se il singolo destinatario (email) è soggetto a SmartMail, se omesso sarà automaticamente false. - 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. - 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'|'PRIORITARIA1'|'RACCOMANDATA'|'RACCOMANDATAAR'|'RACCOMANDATA1'|'RACCOMANDATA1AR'|'MULTIBOX'
tipo: string - desc: Modalità di consegna. - 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.Gli inserti saranno inclusi in ogni lettera di ogni destinatario. 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
posta_options[skip_cap_errors]
=>
'false'
tipo: boolean - desc: Indica di non eseguire la verifica dei cap e procedere nella spedizione ignorando eventuali errori. Il parametro è disponibile solo per la tipologia affrancatura prioritaria e vettore poste italiane. In tutti gli altri casi il parametro verrà considerato 'false' - optional
posta_options[skip_dest_match]
=>
'false'
tipo: boolean - desc: Indica di non eseguire la verifica dei destinatari e procedere nella spedizione ignorando eventuali errori. Il parametro è disponibile solo per la tipologia posta unica. In tutti gli altri casi il parametro verrà considerato 'false' - optional
posta_options[mb][nome]
=>
'nome destinatario multibox'
tipo: string - desc: Nome destinatario multibox. - optional
posta_options[mb][cognome]
=>
'cognome destinatario multibox'
tipo: string - desc: Cognome destinatario multibox. - optional
posta_options[mb][denom]
=>
'Denominazione destinatario multibox'
tipo: string - desc: Denominazione destinatario multibox. - optional
posta_options[mb][denom_extra]
=>
'Denominazione aggiuntiva destinatario multibox'
tipo: string - desc: Denominazione aggiuntiva destinatario multibox. - optional
posta_options[mb][indirizzo]
=>
'indirizzo destinatario multibox'
tipo: string - desc: Indirizzo destinatario multibox. - optional
posta_options[mb][cap]
=>
'43100'
tipo: string - desc: Cap destinatario multibox. - optional
posta_options[mb][citta]
=>
'Parma'
tipo: string - desc: Città destinatario multibox. - optional
posta_options[mb][prov]
=>
'PR'
tipo: string - desc: Provincia destinatario multibox. - optional
posta_options[mb][buste]
=>
'A'|'C'
tipo: string - desc: Tipo buste multibox (A=Aperte,C=Chiuse). - optional
posta_options[mb][dest_sheet]
=>
'false'
tipo: boolean - desc: Indica se abilitare l'inserimento del foglio riepilogativo dei destinatari multibox (default: false). - optional
posta_options[mb][subject]
=>
'Oggetto foglio riepilogativo dei destinatari multibox'
tipo: string - desc: Oggetto foglio riepilogativo dei destinatari multibox (se richiesto). - 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). In caso il parametro non sia valorizzato verrà utilizzato come default la tipologia 'report' - 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
mail_options[unsubscribe_text]
=>
'testo cancellazione'
tipo: string - desc: Testo disiscrizione newsletter. Se vuoto o non passato nessun testo disiscrizione. La funzionalità di cancellazione newsletter è disponibile solo per invii da Db Aziende, Contatti Db Aziende e Rubrica - optional
mail_options[unsubscribe_align]
=>
'L'|'C'|'R'
tipo: string - desc: Definisce l'allineamento del testo per la disiscrizione dalla newsletter. Utilizzare la stringa "L" per allineamento a sinistra, "C" per allineamento centrale e "R" per allineamento a destra. - optional
mail_options[use_pec]
=>
false
tipo: boolean - desc: Indica se utilizzare o meno la PEC nelle spedizioni email. In questo caso devono essere presenti i dati pec nella scheda utente. - optional
mail_options[use_pec_master]
=>
false
tipo: boolean - desc: Indica se utilizzare la PEC dell'account master nelle spedizioni email in caso sia già utilizzato il parametro 'su' per impersonificare un altro utente. - optional
mail_options[use_keywords]
=>
false
tipo: boolean - desc: Indica se utilizzare o meno le parole chiave nelle spedizioni email. - optional
mail_options[sm_enable]
=>
false
tipo: boolean - desc: Indica se utilizzare o meno la SmartMail come metodo di spedizione. - 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 custom del subaccount di riferimento per filtrare le provvigioni restituite. - optional
get_options[go_login]
=>
'true'
tipo: boolean - desc: Indica se ritornare i dati degli account Go collegati all'account multidialogo richiedente. Restituisce anche la stringa da utilizzare per accedere direttamente alla intranet (unilogin, validità 30 minuti) e la data di scadenza della stringa di login in formato ISO (unilogin_expire). - optional
getall:
getall_options[objtype]
=>
'USER'|'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. Il parametro è ignorato in caso di objtype uguale a USER. - optional
report:
report_options[action]
=>
'*'|'sendsms'|'sendfax'|'sendposta'|'sendemail'
tipo: string - desc: Nome operazione per la quale si richiede la reportistica. In caso il parametro non sia specificato oppure venga specificato il valore '*' saranno restituite tutte le reportistiche per tutte le operazioni presenti. - 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,PRE,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
report_options[from_date_update]
=>
'2012-01-01'
tipo: date - desc: Data ultimo aggornamento di partenza filtro per metodo 'report_list' e report_optons[action] = sendemail. - optional
report_options[to_date_update]
=>
'2012-12-31'
tipo: date - desc: Data ultimo aggiornamento di fine filtro per metodo 'report_list' e report_optons[action] = sendemail. - optional
report_options[multisend]
=>
1|2|3
tipo: int - desc: 1: include le code invio preferenziale nella richiesta. 2: esclude le code invio preferenziale nella richiesta. 3: restituisce le sole code di invio preferenziale nella richiesta. (Default: 1). - optional
get_prices:
get_prices_options[action]
=>
'sms'|'fax'|'posta'
tipo: string - desc: Nome operazione per la quale si richiede il costo. - optional
get_prices_options[ndest]
=>
10
tipo: int - desc: Numero destinatari. - optional
get_prices_options[npag]
=>
1
tipo: int - desc: Numero di pagine per richiesta prezzo su fax o posta. - optional
get_prices_options[sms_tipo]
=>
'basic'|'classic'|'report'
tipo: string - desc: Tipologia sms per cui si richiede il prezzo. - optional
get_prices_options[sms_nmsg]
=>
1
tipo: int - desc: Numero messaggi per destinatario in caso di richiesta prezzo per sms. - optional
get_prices_options[fax_prefix]
=>
39
tipo: string - desc: Numero prefisso internazionale in caso di richiesta prezzo fax. (Inserire il numero internazionale senza il '+' davanti) - optional
get_prices_options[posta_affrancatura]
=>
'P'|'R'|'AR'|'T'|'R1'|'R1R'
tipo: string - desc: Tipologia affrancatura posta. - optional
get_prices_options[posta_ottimizza]
=>
'true'|'false'
tipo: boolean - desc: Richiesta ottimizzazione affrancaturas per posta - optional
get_prices_options[posta_formato]
=>
'A4'
tipo: string - desc: Formato per tipologia posta - optional
get_prices_options[posta_grammatura]
=>
'80'
tipo: string - desc: Grammatura per tipologia posta - optional
get_prices_options[posta_fr]
=>
'true'|'false'
tipo: boolean - desc: Parametro fronte/retro posta. - optional
get_prices_options[posta_colore]
=>
'true'|'false'
tipo: boolean - desc: Parametro stampa a colori per posta. - optional
get_prices_options[posta_pinzatura]
=>
'true'|'false'
tipo: boolean - desc: Parametro utilizza pinzatura per posta. - optional
get_prices_options[posta_realtime]
=>
'true'|'false'
tipo: boolean - desc: Parametro stampa logo realtime per posta. - optional
get_prices_options[posta_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
          "npag": 1, (int) numero pagine allegato
        }
      ]
tipo: array - desc: Parametri relativi ad inserti posta per richiesta prezzo. - optional
Multi Send References:
Url - Endpoint:
https://go.multidialogo.it/api/index_pref.php
Method:
POST
Description:
Spedizione e reportistica multicanale (sms, fax, posta, email).
Parametri:
global:
iomode
=>
'json'|'phpserial'|'jsonp'
tipo: string - desc: Metodo di codifica input/output.
action
=>
'multisend'|'report'|'report_list'
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.
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
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
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
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 e email. - optional
files:
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.
          "ide":""  (string) identificativo univoco file
        }
      ]
tipo: array - desc: File da spedire. - optional
sendlist array:
sendlist[i][action]
=>
'sendsms'|'sendfax'|'sendposta'|'sendemail'
tipo: string - desc: Azione richiesta.
sendlist[i][msg]
=>
Messaggio test
tipo:  - desc: Messaggio sms, prima pagina fax. - optional
sendlist[i][sender]
=>
Mittente
tipo:  - desc: Nome o numero mittente posta, sms, fax. - optional
sendlist[i][dest_options][create]
=>
'true'
tipo:  - desc: Indica se creare, aggiornare dati destinatari. - optional
sendlist destinations:
sendlist[i][dest][i][objtype]
=>
CONTATTO|'AZIENDA'|'CONTATTO'
tipo:  - desc: Indica tipo destinatario azione di riferimento.Obbligatorio in caso di parametro dest_options[create]=true. - optional
sendlist[i][dest][i][id]
=>
tipo:  - desc: Indica identificativo Multidialogo destinatario. - optional
sendlist[i][dest][i][unique]
=>
tipo:  - desc: Indica identificativo univoco custom destinatario. - optional
sendlist[i][dest][i][...]
=>
tipo:  - desc: Sono disponibili tutti i parametri dell'array dei destinatari disponibili nell'oggetto API di base (vedere sezione DESTNATION ARRAY nel tab 'basic') - optional
sendlist[i][dest][i][files][i][ide]
=>
tipo:  - desc: Identificativo file di riferimento destinatario. Riferimento ad un file inserito nel parametro generale files. Usato per le azioni sendfax e sendemail - optional
sendlist[i][dest][i][keywords][i][name]
=>
tipo:  - desc: Nome parola chiave personalizzata per destinatario (utilizzato in caso di invio email o fax con keywords). Tutte le occorrenze nel corpo della mail o nella copertina fax verranno sostituite con il corrispondente valore della parola chiave. - optional
sendlist[i][dest][i][keywords][i][value]
=>
tipo:  - desc: Valore parola chiave personalizzata per destinatario (utilizzato in caso di invio email o fax con keywords). - optional
sendlist files:
sendlist[i][files][i][ide]
=>
tipo:  - desc: Identificativo file di riferimento spedizione. Riferimento ad un file inserito nel parametro generale files. Usato per le azioni sendfax, sendposta e sendemail - optional
sendlist SMS options:
sendlist[i][sms_type]
=>
'report'|'classic'|'basic'
tipo: string - desc: Tipo sms. (obbligatorio in caso utilizzo action sendsms). In caso il parametro non sia valorizzato verrà utilizzato come default la tipologia 'report' - optional
sendlist fax options:
sendlist[i][fax_options][sender][fax]
=>
'+390521247791'
tipo:  - desc: Fax mittente. - optional
sendlist[i][fax_options][firstpage]
=>
false
tipo:  - 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
sendlist[i][fax_options][use_keywords]
=>
false
tipo:  - desc: Indica se abilitare l'utilizzo delle parole chiave da sostituire nella copertina fax. In caso sia true verrà generata una coda diversa per ogni destinatario fax. (default: false) - optional
sendlist posta options:
sendlist[i][posta_options][mode]
=>
'NORMAL'|'ARCHIVE'|'UNIQUE'
tipo:  - desc: Scegliere la tipologia di posta desiderata fra posta normale, posta archivio e posta unica.Default 'Normal'. - optional
sendlist[i][posta_options][optimizes_postage]
=>
'true'|'false'
tipo:  - 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
sendlist[i][posta_options][page_mode]
=>
'FRONT'|'BOTH'
tipo:  - desc: Modalità di stampa fronte/fronte-retro. - optional
sendlist[i][posta_options][print_color]
=>
'BW'|'COLOR'
tipo:  - desc: Modalità di stampa bianco-nero/colori. - optional
sendlist[i][posta_options][delivery_type]
=>
'PRIORITARIA'|'RACCOMANDATA'|'RACCOMANDATAAR'|'TARGET'|'RACCOMANDATA1'|'RACCOMANDATA1AR'
tipo:  - desc: Modalità di consegna. Attenzione: la modalità di tipo TARGET richiede la presenza di almeno 100 destinatari. - optional
sendlist[i][posta_options][dest_type]
=>
'RAGSOC'|'NOME'|'BOTH'
tipo:  - desc: Indica solo ragione sociale destinatario, solo nome o tutti e due. - optional
sendlist[i][posta_options][deny_logo]
=>
false
tipo:  - 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
sendlist[i][posta_options][logo_type]
=>
'P'|'M'
tipo:  - 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
sendlist[i][posta_options][staple]
=>
false
tipo:  - desc: Parametro opzionale che consente di richiedere la pinzatura del documento da spedire in caso il numero di fogli sia superiore a 1. - optional
sendlist[i][posta_options][file_descriptor]
=>
'Param.xml'
tipo:  - 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
sendlist[i][posta_options][skip_cap_errors]
=>
false
tipo:  - desc: Indica di non eseguire la verifica dei cap e procedere nella spedizione ignorando eventuali errori.Il parametro è disponibile solo per la tipologia affrancatura prioritaria e vettore poste italiane.In tutti gli altri casi il parametro verrà considerato 'false' - optional
sendlist[i][posta_options][skip_dest_match]
=>
false
tipo:  - desc: Indica di non eseguire la verifica dei destinatari e procedere nella spedizione ignorando eventuali errori.Il parametro è disponibile solo per la tipologia posta unica.In tutti gli altri casi il parametro verrà considerato 'false' - optional
sendlist[i][posta_options][sender][indirizzo]
=>
Via Zarotto 63
tipo:  - desc: Indirizzo mittente. - optional
sendlist[i][posta_options][sender][cap]
=>
43123
tipo:  - desc: Cap mittente. - optional
sendlist[i][posta_options][sender][citta]
=>
Parma
tipo:  - desc: Città mittente. - optional
sendlist[i][posta_options][sender][provincia]
=>
PR
tipo:  - desc: Sigla provincia mittente. - optional
sendlist[i][posta_options][sender][nazione]
=>
IT
tipo:  - desc: Nazione mittente (default IT) - optional
sendlist[i][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":{
            "ide":"idefile1", (string) Identificativo file di riferimento. Riferimento ad un file inserito nel parametro generale files.
          }
        }
      ]
tipo: array - desc: Inserti in caso di Posta.Gli inserti saranno inclusi in ogni lettera di ogni destinatario. Gli inserti potranno avere parametri (Colore, B/N, ecc...) personalizzati. - optional
sendlist[i][posta_options][attach_in]
=>
      [
        {
          "file":{
            "ide":"idefile1", (string) Identificativo file di riferimento. Riferimento ad un file inserito nel parametro generale files.
          }
        }
      ]
tipo: array - desc: Allegati per Posta Unica. Gli allegati erediteranno i parametri (Colore, B/N, ecc...) impostati per la posta. - optional
sendlist email options:
sendlist[i][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
sendlist[i][mail_options][subject]
=>
'Test mail api md'
tipo: string - desc: Oggetto della mail. - optional
sendlist[i][mail_options][body]
=>
'Messaggio di test mail'
tipo: string - desc: Corpo della mail.Testo o html. - optional
sendlist[i][mail_options][unsubscribe_text]
=>
'testo cancellazione'
tipo: string - desc: Testo disiscrizione newsletter. Se vuoto o non passato nessun testo disiscrizione. La funzionalità di cancellazione newsletter è disponibile solo per invii da Db Aziende, Contatti Db Aziende e Rubrica - optional
sendlist[i][mail_options][unsubscribe_align]
=>
'L'|'C'|'R'
tipo: string - desc: Definisce l'allineamento del testo per la disiscrizione dalla newsletter. Utilizzare la stringa "L" per allineamento a sinistra, "C" per allineamento centrale e "R" per allineamento a destra. - optional
sendlist[i][mail_options][use_pec]
=>
false
tipo: boolean - desc: Indica se utilizzare o meno la PEC nelle spedizioni email. - optional
sendlist[i][mail_options][use_keywords]
=>
false
tipo: boolean - desc: Indica se utilizzare o meno le parole chiave nelle spedizioni email. - optional
report options:
report_options[multisendcode]
=>
'XXXXXXXXXXXXX'
tipo: string - desc: Codice invio operazione (identificativo univoco operazione restituito dal metodo multisend) - optional
report_options[queue_details]
=>
'true'
tipo: boolean - desc: Indica se tornare il dettaglio delle spedizioni ed i costi nella reportistica. Non supportato per il metodo 'report_list' - 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[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 delle spedizioni (Default: true). - optional
Multi Send Example:
Rappresentazione JSON chiamata API Multisend con le seguenti caratteristiche:
  • invio sms a 2 contatti presenti in rubrica.
  • invio fax a 3 contatti presenti in rubrica. Un contatto possiede un allegato personalizzato oltre al file del fax comune per tutti i destinatari.
  • invio posta archivio con aggiunta di un allegato comune da inserire per tutti i destinatari.
  • invio email a 2 contatti presenti in rubrica. Un contatto possiede un allegato personalizzato oltre al file allegato email comune per tutti i destinatari. Sono state inoltre specificate delle parole chiavi personalizzate per ciascun destinatario ed è stato abilitato l'utilizzo dell parole chiave.
                        
              "iomode":"json",
              "action":"multisend",
              "auth":{
                "user":"testuser",
                "pass":"95670a6e818de6587c9df172ad7fg635"
              },
              "memo":"Promemoria invio preferenziale 2",
              "notify_email":"info@netbuilder.it",
              "files":[
                {
                  "name":"file_esempio_fax.pdf",
                  "size":false,
                  "data":"DQo=",
                  "ide":"filexfax"
                },
                {
                  "name":"file_esempio_posta.zip",
                  "size":false,
                  "data":"",
                  "ide":"filexposta"
                },
                {
                  "name":"file_esempio_email.pdf",
                  "size":false,
                  "data":"DQo=",
                  "ide":"filexemail"
                },
                {
                  "name":"file_esempio_allegato.pdf",
                  "size":false,
                  "data":"DQo=",
                  "ide":"fileallegatocomune"
                }
              ],
              "sendlist":[
                {
                  "action":"sendsms",
                  "msg":"messaggio sms",
                  "sender":"MittSms",
                  "dest":[
                    {
                      "objtype":"CONTATTO",
                      "id":"6453"
                    },
                    {
                      "objtype":"CONTATTO",
                      "id":"6454"
                    }
                  ]
                },
                {
                  "action":"sendfax",
                  "msg":"Testo Copertina Fax.",
                  "sender":"MittFax",
                  "fax_options":{
                    "sender":{
                      "fax":"3905217433231"
                    },
                    "first_page":1
                  },
                  "dest":[
                    {
                      "objtype":"CONTATTO",
                      "id":"6453"
                    },
                    {
                      "objtype":"CONTATTO",
                      "id":"6454"
                    },
                    {
                      "objtype":"CONTATTO",
                      "id":"6455",
                      "files":[
                        {
                          "ide":"fileallegatocomune"
                        }
                      ]
                    }
                  ],
                  "files":[
                    {
                      "ide":"filexfax"
                    }
                  ]
                },
                {
                  "action":"sendposta",
                  "sender":"Mittente Posta",
                  "posta_options":{
                    "mode":"ARCHIVE",
                    "optimizes_postage":0,
                    "page_mode":"FRONT",
                    "print_color":"BW",
                    "delivery_type":"RACCOMANDATA",
                    "dest_type":"BOTH",
                    "staple":"0",
                    "file_descriptor":"Param.xml",
                    "attach":[
                      {
                        "fr":"NO",
                        "colore":"NO",
                        "formato":"A4",
                        "grammatura":"80",
                        "pinzatura":"0",
                        "file":{
                          "ide":"fileallegatocomune"
                        }
                      }
                    ],
                    "sender":{
                      "indirizzo":"via zarotto 63",
                      "cap":"43034",
                      "citta":"Parma",
                      "provincia":"PR",
                      "nazione":"IT"
                    }
                  },
                  "files":[
                    {
                      "ide":"filexposta"
                    }
                  ]
                },
                {
                  "action":"sendemail",
                  "dest":[
                    {
                      "objtype":"CONTATTO",
                      "id":"6453",
                      "files":[
                        {
                          "ide":"fileallegatocomune"
                        }
                      ],
                      "keywords":[
                        {
                          "name":"{mykeyword1}",
                          "value":"valore1"
                        }
                      ]
                    },
                    {
                      "objtype":"CONTATTO",
                      "id":"6454",
                      "keywords":[
                        {
                          "name":"{mykeyword1}",
                          "value":"valore2"
                        }
                      ]
                    }
                  ],
                  "mail_options":{
                    "from":"info@netbuilder.it",
                    "subject":"Oggetto mail preferenziale",
                    "body":"Corpo mail.keyword1:{mykeyword1}",
                    "use_pec":0,
                    "use_keywords":1,
                    "use_pec_master":0,
                  },
                  "files":[
                    {
                      "ide":"filexemail"
                    }
                  ]
                }
              ]
Multi Send Return:
Esempio rappresentazione JSON risposta chiamata API multisend ipotizzando una chiamata con 4 canali differenti (sms, fax, posta, email) così come riportata nel tab 'Example'.

              
              {
                "multisendcode":"XXXXXXXXXXXXX",
                "sendsms.0":{
                  "sendsms":{
                    "codiceinvio":"XXXXX-XXXXXXXXXXXX",
                    "sent":2,
                    "sent_error":null,
                    "dest_error":null
                  },
                  "status":"ok"
                },
                "sendfax.1":{
                  "sendfax":{
                    "codiceinvio":"XXXXX-XXXXXXXXXXXX",
                    "sent":2,
                    "sent_error":null,
                    "dest_error":null
                  },
                  "status":"ok",
                  "dest":{
                    "2":{
                      "sendfax":{
                        "codiceinvio":"XXXXX-XXXXXXXXXXXX",
                        "sent":1,
                        "sent_error":null,
                        "dest_error":null
                      },
                      "status":"ok"
                    }
                  }
                },
                "sendposta.2":{
                  "sendposta":{
                    "codiceinvio":"XXXXX-XXXXXXXXXXXX",
                    "sent":null,
                    "sent_error":null,
                    "dest_error":null
                  },
                  "status":"ok"
                },
                "sendemail.3":{
                  "sendemail":{
                    "destinatari":2
                    ,"sendcode":"XXXXX-XXXXXXXXXXXX"
                  },
                  "status":"ok"
                }
              }
Multi Send Report Return:
Esempio rappresentazione JSON risposta chiamata API multisend report ipotizzando di avere precedentemente generato una coda con 4 canali differenti (sms, fax, posta, email) così come riportata nel tab 'Example'.

{
	"report": {
		"multisendcode": "XXXXXXXXXXXXXX",
		"creation": "1-apr-2014 09:27",
		"memo": "Promemoria invio preferenziale",
		"author": "test author",
		"nqueue": "6",
		"queue_type": [
			{
				"code": "F",
				"label": "Fax",
				"nqueue": 3
			},
			{
				"code": "M",
				"label": "Email",
				"nqueue": 1
			},
			{
				"code": "PA",
				"label": "Posta archivio",
				"nqueue": 1
			},
			{
				"code": "S",
				"label": "Sms",
				"nqueue": 1
			}
		],
		"recipient": "8",
		"sent": "0",
		"queue_details": [
			{
				"queue_type_code": "F",
				"sendcode": "XXXXXXXXXXXXXX",
				"creation": "1-apr-2014 09:27",
				"delivery": "1-apr-2014 09:27",
				"creation_iso": "2014-04-01 09:27",
				"delivery_iso": "2014-04-01 09:27",
				"memo": "Promemoria invio preferenziale",
				"recipient": "1",
				"sent": "0",
				"enable": "1",
				"status": "Attesa",
				"author": "test author",
				"author_username": "testauthor",
				"type": "FAX",
				"total_price": "0,00",
				"print_price": "0,00",
				"postage_price_pt": "0,00",
				"postage_price_tnt": "0,00",
				"inserts_price": "0,00",
				"postage_price": "0,00",
				"staple_price": "0,00",
				"realtime_price": "0,00",
				"tax_price": "0,00",
				"extra_price": "0,00",
				"print_price_iva": "22%",
				"postage_price_pt_iva": "0",
				"postage_price_tnt_iva": "22%",
				"inserts_price_iva": "22%",
				"staple_price_iva": "22%",
				"realtime_price_iva": "22%",
				"tax_price_iva": "22%",
				"extra_price_iva": "22%",
				"indirect_payment": 0
			},
			{
				"queue_type_code": "S",
				"sendcode": "XXXXXXXXXXXXXX",
				"creation": "1-apr-2014 09:27",
				"delivery": "1-apr-2014 09:27",
				"creation_iso": "2014-04-01 09:27",
				"delivery_iso": "2014-04-01 09:27",
				"memo": "Promemoria invio preferenziale",
				"recipient": "2",
				"sent": "0",
				"enable": "1",
				"status": "Attesa",
				"author": "test author",
				"author_username": "testauthor",
				"type": "SMS",
				"total_price": "0,00",
				"print_price": "0,00",
				"postage_price_pt": "0,00",
				"postage_price_tnt": "0,00",
				"inserts_price": "0,00",
				"postage_price": "0,00",
				"staple_price": "0,00",
				"realtime_price": "0,00",
				"tax_price": "0,00",
				"extra_price": "0,00",
				"print_price_iva": "22%",
				"postage_price_pt_iva": "0",
				"postage_price_tnt_iva": "22%",
				"inserts_price_iva": "22%",
				"staple_price_iva": "22%",
				"realtime_price_iva": "22%",
				"tax_price_iva": "22%",
				"extra_price_iva": "22%",
				"indirect_payment": 0
			},
			{
				"queue_type_code": "F",
				"sendcode": "XXXXXXXXXXXXXX",
				"creation": "1-apr-2014 09:27",
				"delivery": "1-apr-2014 09:27",
				"creation_iso": "2014-04-01 09:27",
				"delivery_iso": "2014-04-01 09:27",
				"memo": "Promemoria invio preferenziale",
				"recipient": "2",
				"sent": "0",
				"enable": "1",
				"status": "Attesa",
				"author": "test author",
				"author_username": "testauthor",
				"type": "FAX",
				"total_price": "0,00",
				"print_price": "0,00",
				"postage_price_pt": "0,00",
				"postage_price_tnt": "0,00",
				"inserts_price": "0,00",
				"postage_price": "0,00",
				"staple_price": "0,00",
				"realtime_price": "0,00",
				"tax_price": "0,00",
				"extra_price": "0,00",
				"print_price_iva": "22%",
				"postage_price_pt_iva": "0",
				"postage_price_tnt_iva": "22%",
				"inserts_price_iva": "22%",
				"staple_price_iva": "22%",
				"realtime_price_iva": "22%",
				"tax_price_iva": "22%",
				"extra_price_iva": "22%",
				"indirect_payment": 0
			},
			{
				"queue_type_code": "F",
				"sendcode": "XXXXXXXXXXXXXX",
				"creation": "1-apr-2014 09:27",
				"delivery": "1-apr-2014 09:27",
				"creation_iso": "2014-04-01 09:27",
				"delivery_iso": "2014-04-01 09:27",
				"memo": "Promemoria invio preferenziale",
				"recipient": "1",
				"sent": "0",
				"enable": "1",
				"status": "Attesa",
				"author": "test author",
				"author_username": "testauthor",
				"type": "FAX",
				"total_price": "0,00",
				"print_price": "0,00",
				"postage_price_pt": "0,00",
				"postage_price_tnt": "0,00",
				"inserts_price": "0,00",
				"postage_price": "0,00",
				"staple_price": "0,00",
				"realtime_price": "0,00",
				"tax_price": "0,00",
				"extra_price": "0,00",
				"print_price_iva": "22%",
				"postage_price_pt_iva": "0",
				"postage_price_tnt_iva": "22%",
				"inserts_price_iva": "22%",
				"staple_price_iva": "22%",
				"realtime_price_iva": "22%",
				"tax_price_iva": "22%",
				"extra_price_iva": "22%",
				"indirect_payment": 0
			},
			{
				"queue_type_code": "PA",
				"sendcode": "XXXXXXXXXXXXXX",
				"creation": "1-apr-2014 09:27",
				"delivery": "1-apr-2014 09:27",
				"creation_iso": "2014-04-01 09:27",
				"delivery_iso": "2014-04-01 09:27",
				"memo": "Promemoria invio preferenziale",
				"recipient": "0",
				"sent": "0",
				"enable": "1",
				"status": "Attesa",
				"author": "test author",
				"author_username": "testauthor",
				"type": "POSTA ARCHIVIO",
				"notification": "info@xxxxxxx.it",
				"total_price": "0,00",
				"print_price": "0,00",
				"postage_price_pt": "0,00",
				"postage_price_tnt": "0,00",
				"inserts_price": "0,00",
				"postage_price": "0,00",
				"staple_price": "0,00",
				"realtime_price": "0,00",
				"tax_price": "0,00",
				"extra_price": "0,00",
				"print_price_iva": "22%",
				"postage_price_pt_iva": "0",
				"postage_price_tnt_iva": "22%",
				"inserts_price_iva": "22%",
				"staple_price_iva": "22%",
				"realtime_price_iva": "22%",
				"tax_price_iva": "22%",
				"extra_price_iva": "22%",
				"indirect_payment": 0
			},
			{
				"queue_type_code": "M",
				"sendcode": "XXXXXXXXXXXXXX",
				"creation": "2014-04-01 09:27",
				"first_delivery": "",
				"delivery": "",
				"memo": "Promemoria invio preferenziale",
				"enable": "1",
				"status": "waiting",
				"share": "0",
				"pec": "0",
				"subject": "Oggetto mail preferenziale",
				"recipient": "2",
				"sent": "0",
				"viewed": 0,
				"errors": 0,
				"unsubscription": 0
			}
		],
		"global_price": "0,00"
	},
	"status": "ok"
}
Url - Endpoint:
https://go.multidialogo.it/api/index.php
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" | "get_prices",
    • "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" | "RACCOMANDATA1" | "RACCOMANDATA1AR",
      • "dest_type" : "RAGSOC" | "NOME" | "BOTH",
      • "deny_logo" : "true" | "false",
      • "logo_type" : "P" | "M",
      • "staple" : "true" | "false",
      • "file_descriptor" : "",
      • "skip_cap_errors" : "true" | "false",
      • "skip_dest_match" : "true" | "false",
      • "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" : "",
        },
      • "mb" : {
        • "nome" : "",
        • "cognome" : "",
        • "denom" : "",
        • "indirizzo" : "",
        • "cap" : "",
        • "citta" : "",
        • "provincia" : "",
        • "nazione" : "",
        • "buste" : "A" | "C",
        • "dest_sheet" : "true" | "false",
        },
      },
    • "fax_options" : {
      • "sender" : {
        • "fax" : "",
        },
      • "first_page" : "true" | "false",
      },
    • "mail_options" : {
      • "from" : "",
      • "subject" : "",
      • "body" : "",
      • "unsubscribe_text" : "",
      • "unsubscribe_align" : "L" | "C" | "R",
      • "use_pec" : "true" | "false",
      • "use_pec_master" : "true" | "false",
      • "use_keywords" : "true" | "false",
      },
    • "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" : "",
        },
      • "go_login" : "true" | "false",
      },
    • "getall_options" : {
      • "objtype" : "USER" | "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" :
      • "from_date_update" : "2012-01-01",
      • "to_date_update" : "2012-12-31",
      • "multisend" : "1" | "2" | "3",
      },
    • "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" :
        },
      ]
    • "get_prices_options" : {
      • "action" : "sms" | "fax" | "posta",
      • "ndest" : "",
      • "sms_tipo" : "basic" | "classic" | "report",
      • "sms_nmsg" :
      • "npag" :
      • "fax_prefix" : "39",
      • "posta_affrancatura" : "P" | "R" | "AR" | "T" | "R1" | "R1R",
      • "posta_ottimizza" : "1" | "0",
      • "posta_formato" : "A4",
      • "posta_grammatura" : "80",
      • "posta_fr" : "1" | "0",
      • "posta_colore" : "1" | "0",
      • "posta_pinzatura" : "1" | "0",
      • "posta_realtime" : "1" | "0",
      • "posta_attach" : [
        • {
          • "fr" : "1" | "0",
          • "colore" : "1" | "0",
          • "formato" : "A4",
          • "grammatura" : "80",
          • "pinzatura" : "1" | "0",
          • "npag" :
          },
        ]
      },
    • "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"
}
get_prices:
Esempio1:
HTML/PHP
Calcolo costo operazione sms
Return json: 
{
  "get_prices":{
    "sms":{
      "prezzo_cli":0.89
    }
  },
  "status":"ok"
}
Esempio2:
HTML/PHP
Calcolo costo operazione fax
Return json: 
{
  "get_prices":{
    "fax":{
      "prezzo_cli":1.32
    }
  },
  "status":"ok"
}
Esempio3:
HTML/PHP
Calcolo costo operazione posta
Return json: 
{
  "get_prices":{
    "posta":{
      "prezzo_cli":6.77,
      "prezzo_cli_pinzatura":0.72,
      "prezzo_cli_realtime":0.59,
      "affr_soggetta":true,
      "prezzo_cli_affr":24.2,
      "prezzo_cli_attach":5.78
    }
  },
  "status":"ok"
}
TOKEN (GET) | PROVIDERS (GET) | DOCUMENTS (GET) | FILES (GET) | CATEGORIES (GET)
TOKEN:
Url - Endpoint:
https://multifatture.multidialogo.it/api/token
Method:
GET
Parametri:
username
=>
'myusername'
tipo: string - desc: Username di accesso a Multidialogo. - required
password
=>
'34819d7beeabb9260a5c854bc85b3e44'
tipo: string - desc: Password di accesso a Multidialogo codificata in md5. - required
PROVIDERS:
Url - Endpoint:
https://multifatture.multidialogo.it/api/providers
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
getall
=>
true | false
tipo: boolean - desc: Indica se tornare la lista completa dei providers supportati. Il default è false (ritorna solo i providers disponibili per l'account autenticato) - optional
fiscal_code
=>
'xxxxxxxxxxxxxxxx'
tipo: string - desc: Filtro risultati per codice fiscale. - optional
vat_code
=>
'xxxxxxxxxxx'
tipo: string - desc: Filtro risultati per partita iva. - optional
email
=>
'xxxxxxxxxxx@xxxx.xx'
tipo: string - desc: Filtro risultati per email. - optional
username
=>
'xxxxxxxxxxxx'
tipo: string - desc: Filtro risultati per username. - optional
check_documents
=>
1 | 0
tipo: boolean - desc: Indica se verificare o no la presenza di documenti per i providers selezionati. Se 1 per ciascun provider viene restituito il campo aggiuntivo 'hasdocuments' valorizzato a 1 (se presente almeno un documento) o 0 (se non presenti nessun documento). - optional
DOCUMENTS:
Url - Endpoint:
https://multifatture.multidialogo.it/api/documents
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
idprovider
=>
*
tipo: int - desc: Id provider ottenuto da richiesta GET https://multifatture.multidialogo.it/api/providers (vedi PROVIDERS). Utilizzare il carattere '*' per cercare fara tutti i providers abilitati. - required
doctype
=>
I
tipo: string - desc: Tipo di documento. I = invoice, C = creditnote, R = receipt, * = all. Default I. - required
date_from
=>
'2016-01-01'
tipo: date iso - desc: Filtro risultati per data da in riferimento alla data della fattura. - optional
date_to
=>
'2016-01-31'
tipo: date iso - desc: Filtro risultati per data a in riferimento alla data della fattura. - optional
edit_date_from
=>
'2016-01-01'
tipo: date iso - desc: Filtro risultati per data da in riferimento alla data di ultima modifica della fattura (data in cui la fattura ha subito una variazione). - optional
edit_date_to
=>
'2016-01-31'
tipo: date iso - desc: Filtro risultati per data a in riferimento alla data di ultima modifica della fattura (data in cui la fattura ha subito una variazione). - optional
import_date_from
=>
'2016-01-01'
tipo: date iso - desc: Filtro risultati per data da in riferimento alla data in cui l'importazione iniziale della fattura all'interno del sistema è conclusa e completa. - optional
import_date_to
=>
'2016-01-31'
tipo: date iso - desc: Filtro risultati per data a in riferimento alla data in cui l'importazione iniziale della fattura all'interno del sistema è conclusa e completa. - optional
return_type
=>
'json'
tipo: string - desc: Tipo di ritorno desiderato. Il default è json. Sarà possibile indicare altri formati privati e non in accordo con i clienti. - optional
accounted
=>
1 | 0
tipo: boolean int - desc: Filtro documenti per proprietà accounted (contabilizzata). - optional
DOCUMENTS:
Url - Endpoint:
https://multifatture.multidialogo.it/api/documents/{document_id}
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
DOCUMENT:
Url - Endpoint:
https://multifatture.multidialogo.it/api/documents/properties
Method:
POST
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
ids
=>
[123,456]
tipo: array - desc: Array id documenti da modificare.At least one - required
accounted
=>
1|0
tipo: boolean int - desc: Indica se impostare la proprietà contabilizzata a si (1) o no (0). - required
FILES:
Url - Endpoint:
https://multifatture.multidialogo.it/api/files/{document_id}
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
attachtype
=>
'document'|'report'|'*'
tipo: string - desc: Tipo documento richiesto nel caso il provider contenga diversi documenti collegati al principale. Il default è 'document'. La lista dei documenti presenti per provider può essere ottenuta da richiesta GET https://multifatture.multidialogo.it/api/providers (vedi PROVIDERS). - optional
CATEGORIES:
Url - Endpoint:
https://multifatture.multidialogo.it/api/categories
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
INVOICES (deprecato):
Url - Endpoint:
https://multifatture.multidialogo.it/api/invoices
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
idprovider
=>
*
tipo: int - desc: Id provider ottenuto da richiesta GET https://multifatture.multidialogo.it/api/providers (vedi PROVIDERS). Utilizzare il carattere '*' per cercare fara tutti i providers abilitati. - required
date_from
=>
'2016-01-01'
tipo: date iso - desc: Filtro risultati per data da in riferimento alla data della fattura. - optional
date_to
=>
'2016-01-31'
tipo: date iso - desc: Filtro risultati per data a in riferimento alla data della fattura. - optional
edit_date_from
=>
'2016-01-01'
tipo: date iso - desc: Filtro risultati per data da in riferimento alla data di ultima modifica della fattura (data in cui la fattura ha subito una variazione). - optional
edit_date_to
=>
'2016-01-31'
tipo: date iso - desc: Filtro risultati per data a in riferimento alla data di ultima modifica della fattura (data in cui la fattura ha subito una variazione). - optional
import_date_from
=>
'2016-01-01'
tipo: date iso - desc: Filtro risultati per data da in riferimento alla data in cui l'importazione iniziale della fattura all'interno del sistema è conclusa e completa. - optional
import_date_to
=>
'2016-01-31'
tipo: date iso - desc: Filtro risultati per data a in riferimento alla data in cui l'importazione iniziale della fattura all'interno del sistema è conclusa e completa. - optional
return_type
=>
'json'
tipo: string - desc: Tipo di ritorno desiderato. Il default è json. Sarà possibile indicare altri formati privati e non in accordo con i clienti. - optional
DOCUMENT (deprecato):
Url - Endpoint:
https://multifatture.multidialogo.it/api/document
Method:
GET
Parametri:
token
=>
'mytoken'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/token (vedi TOKEN). - required
invoice_id
=>
1
tipo: int - desc: Id documento (fattura) ottenuto da richiesta GET https://multifatture.multidialogo.it/api/invoices (vedi INVOICES). - required
doctype
=>
'invoice'|'report'
tipo: string - desc: Tipo documento richiesto nel caso il provider contenga diversi documenti collegati alla fattura. Il default è 'invoice'. La lista dei documenti presenti per provider può essere ottenuta da richiesta GET https://multifatture.multidialogo.it/api/providers (vedi PROVIDERS). - optional
CHECKACCOUNTMD (GET) | TOKENPROVIDER (GET) | DOCUMENT (POST)
TOKENPROVIDER:
Url - Endpoint:
https://multifatture.multidialogo.it/api/tokenprovider
Method:
GET
Parametri:
username
=>
'providerusername'
tipo: string - desc: Username di accesso a portale Multidialogo - Fornitori. - required
password
=>
'34819d7beeabb9260a5c854bc85b3e44'
tipo: string - desc: Password di accesso a portale Multidialogo - Fornitori codificata in md5. - required
CHECKACCOUNTMD:
Url - Endpoint:
https://multifatture.multidialogo.it/api/checkaccountmd
Method:
GET
Parametri:
token
=>
'mytokenprovider'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/tokenprovider (vedi TOKENPROVIDER). - OPTIONAL
piva
=>
'11111111111'
tipo: string - desc: Partita iva account da ricercare. - required if not cf
cf
=>
'codicefiscale'
tipo: string - desc: Codice fiscale account da ricercare. - required if not piva
DOCUMENT:
Url - Endpoint:
https://multifatture.multidialogo.it/api/document
Method:
POST
Parametri:
token
=>
'mytokenprovider'
tipo: string - desc: Token ottenuto da richiesta GET https://multifatture.multidialogo.it/api/tokenprovider (vedi TOKENPROVIDER). - required
doctype
=>
I
tipo: string - desc: Tipo di documento. I = invoice, C = creditnote, R = receipt. - required
number
=>
'100'
tipo: string - desc: Numero fattura per intero. Esempio: 5094_2016B - required
document_date
=>
'2016-09-11'
tipo: date iso - desc: Data fattura - required
payment
=>
'Bonifico bancario'
tipo: string - desc: Tipo di pagamento - required
payment_status
=>
'P'
tipo: string - desc: ND:Non disponibile | NP:Non pagata | C:in fase di contabilizzazione | A:addebito c/c alla data di scadenza | G:girata a terzi | PP:Parzialmente pagata | P:Pagata - required, accept one of this: ND | NP | C | A | G | PP | P
reason
=>
'reason'
tipo: string - desc: Causale da indicare al momento del pagamento - optional
expiration
=>
'2016-12-31'
tipo: date iso - desc: Scadenza fattura - optional
name
=>
'Cliente srl'
tipo: string - required
fiscal_code
=>
'fiscal_code'
tipo: string - desc: Codice fiscale - required (if not vat_code)
vat_code
=>
'vat_code'
tipo: string - desc: Partita Iva - required (if not fiscal_code)
address
=>
'via Emilia'
tipo: string - required
postcode
=>
'43126'
tipo: string - required
city
=>
'Parma'
tipo: string - required
province
=>
'PR'
tipo: string - optional
notes
=>
'notes'
tipo: string - optional
customer_code
=>
'customer_code'
tipo: string - optional
pod_json
=>
'[{"code":"00000000","vat_perc":"22","notax_amount":"200"}]'
tipo: json string - optional
total_amount
=>
0
tipo: float - desc: Totale fattura da pagare - required
notax_amount
=>
0
tipo: float - desc: Imponibile fattura - required
vat_amount
=>
0
tipo: float - desc: Totale iva - required
withholding_amount
=>
0
tipo: float - desc: Totale ritenuta d'acconto - optional
withholding_perc
=>
0
tipo: float - desc: Percentuale ritenuta d'acconto applicata - optional
withholding_notax
=>
0
tipo: float - desc: Totale imponibile soggetto a ritenuta d'acconto - optional
extra_notax
=>
0
tipo: float - desc: Spese aggiuntive al netto dell' iva (es.: bolli, spese di spedizione) - optional
contribution_notax
=>
0
tipo: float - desc: Contributo previdenziale al netto dell' iva - optional
contribution_has_withholding
=>
1 | 0
tipo: boolean - desc: Indica se il contributo previdenzile è soggetto a ritenuta d'acconto o no. - optional
files
=>
'[{"document":"base64String"}]'
tipo: array - desc: Array con chiave uguale al tipo di documento ('document' o 'report') e come valore il contenuto del file codificato in base64 (base64 string) - required
NEW!
ATTENZIONE! tutte le opzioni qui elencate non sono obbligatorie, se NON indicate verranno utilizzate
le opzioni configurate nell' interfaccia utente; in caso esse non siano impostate, verranno utilizzati i valori predefiniti di sistema.

Ricordarsi di settare a true la variabile mail_options[sm_enable]
Url - Endpoint:
https://go.multidialogo.it/api/index_pref.php
Method:
POST, GET
Parametri:
sendemail:
mail_options[smartmail][options][maxtime]
=>
24
tipo: integer - desc: Indica il periodo in ore entro il quale i destinatari possono consultare il link contenuto nella mail - optional
mail_options[smartmail][options][mode]
=>
all | partial
tipo: boolean - desc: Indica se tutti i destinatari sono soggetti a SmartMail o solo alcuni.(vedi dest[i][sm_enable]) - optional
mail_options[smartmail][options][text_link]
=>
tipo: string - desc: Indica il testo alternativo in sostituzione del link di conferma - optional
mail_options[smartmail][options][link_align]
=>
TL|TC|TR|BL|BC|BR oppure il tag {_SMARTLINK_}
tipo: string - desc: Indica la posizione del link rispetto al body della mail (se il body contiene il tag speciale {_SMARTLINK_} il link verrà posizionato al posto del tag) - optional
mail_options[smartmail][options][land_logo]
=>
      [
        {
          "name":"filename.jpg", (string) nome del file (da API sono accettati solo file tipo jpeg)
          "size":7097, (int) dimensione del file in byte
          "data":""  (base64Binary) contenuto del file codificato in base64
        }
      ]
tipo: array - desc: Contiene un array di valori inerenti il logo da utilizzare nella pagina web in cui il cliente deve confermare la presa visione - optional
mail_options[smartmail][options][land_body]
=>
tipo: html - desc: Indica il codice html da utilizzare per la costruzione della pagina web in cui il cliente deve confermare la presa visione. Al suo interno sono gestiti una serie di tag per la corretta sostituzione dei dati nella pagina:
{_NOME_} sostituisce i dati anagrafici del destinatario
{_DATAMAIL_} sostituisce la data di invio della mail
{_OGGETTOEMAIL_} sostituisce l' oggetto della mail
{_ALLEGATI_} sostituisce l' elenco degli allegati inviati ai singoli destinatari
{_NOMEMITTENTE_} sostituisce i dati anagrafici del mittente
{_DATALAND_} sostituisce la data di visualizzaizone della pagina web - optional
mail_options[smartmail][options][confirm_land_align]
=>
tipo: string - desc: Indica la posizione del bottone di conferma nella pagina web in cui il cliente deve confermare la presa visione - optional
mail_options[smartmail][options][confirm_land_text]
=>
L|C|R
tipo: string - desc: Indica il testo da inserire nel bottone di conferma nella pagina web in cui il cliente deve confermare la presa visione - optional
sendposta:
mail_options[smartmail][options][alt][mode]
=>
sendposta
tipo: string - desc: Indica il metodo di spedizione alternativo - optional
mail_options[smartmail][options][alt][options]
=>
      [
        {
          "page_mode" => "FRONT" | "BOTH",
          "print_color" => "BW" | "COLOR",
          "delivery_type" => "PRIORITARIA" | "RACCOMANDATA" | "RACCOMANDATAAR" | "RACCOMANDATA1" | "RACCOMANDATA1AR"
          "dest_type" => "RAGSOC" | "NOME" | "BOTH",
          "staple" => "true" | "false",
        }
      ]
tipo: array - desc: Contiene un array con le opzioni di configurazione per il metodo sendposta - optional
mail_options[smartmail][options][alt][options][sender]
=>
      [
        {
          "name" => "Nome Cognome",
          "indirizzo" => "",
          "cap" => "", In caso di spedizione raccomandata il cap verrà verificato
          "citta" => "",
          "provincia" => "",
          "nazione" => "",
        }
      ]
tipo: array - desc: Contiene un array con i dati del mittente - optional