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.
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
[
{
"nome":'nomecampo', (string) nome campo
"valore":'valorecampo', (string) valore
"hidden":false, (bool) indica se il campo è nascosto in visualizzazione sulla piattaforma
}
]Aggiunto supporto per metodi sendemail e sendshare.
Parametro presente per retrocompatibilità, ma sostituito dal più recente e strutturato parametro files. - optional
Aggiunto supporto per metodi sendemail e sendshare.
Parametro presente per retrocompatibilità, ma sostituito dal più recente e strutturato parametro files. - optional
Aggiunto supporto per metodi sendemail e sendshare.
Parametro presente per retrocompatibilità, ma sostituito dal più recente e strutturato parametro files. - optional
[
{
"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.
}
]
[
{
"id":1, (int) identificativo ruolo
"nome":'categoria1', (string) descrizione ruolo
}
]
[
{
"id":1, (int) identificativo ruolo
"descrizione":'ruolo1', (string) descrizione ruolo
}
]
[
{
"nome":'nomecampo', (string) nome campo
"valore":'valorecampo', (string) valore
"hidden":false, (bool) indica se il campo è nascosto in visualizzazione sulla piattaforma
}
]
[
{
"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
}
}
]
[
{
"file":{
"name":"filename.pdf", (string) nome del file
"size":7097, (int) dimensione del file in byte
"data":"" (base64Binary) contenuto del file codificato in base64
}
}
]- _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" : "",
-
"file" : {
-
{
-
"sender" : {
- "indirizzo" : "",
- "cap" : "",
- "citta" : "",
- "provincia" : "",
- "nazione" : "",
-
"fax_options" : {
-
"sender" : {
- "fax" : "",
- "first_page" : "true" | "false",
-
"sender" : {
-
"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" :
-
{
- {
- "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",
Semplice invio con stringa numeri destinatari generica separati da virgola.
Invio con destinatari da contatti rubrica e opzione per creare nuovi contatti se non esistono.
Semplice invio con stringa numeri destinatari generica separati da virgola e testo fax manuale.
Invio con destinatari da db aziende e opzione per creare nuove aziende se non esistono.Upload diretto dei file da inviare.
Semplice invio con lista destinatari generica (nessun passaggio di id o unique, parametro dest_options[create] false).Upload diretto dei file da inviare.
Invio con lista destinatari presa da db aziende e identificazione aziende tramite parametro unique.Upload diretto dei file da inviare.
Semplice invio posta archivio di tipo prioritaria.
Semplice invio posta unica di tipo prioritaria con 2 allegati.
Semplice invio singola mail a destinatario generico.
Semplice invio mail a 2 aziende già presenti con allegato.
Semplice creazione di una cartella condivisa.
Semplice inserimento/aggiornamento di 2 contatti e 2 aziende.
Semplice recupero dei dati di un contatto tramite unique.
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]'.
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"
}
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"
}
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"
}
Lista elenco categorie aziende disponibili.
Return json:
{
"list_az_cat":
{"categorie":[
{"id":"1","nome":"categoria1"},
{"id":"2","nome":"categoria2"},
...
]
},
"status":"ok"
}