Questa funzione consente di inserire un file ZIP in Base64 contenente una lista di contatti in formato CSV, caricare i contatti nella rubrica di Socialmailer e aggiungerli come destinatari di un messaggio unificato precedentemente creato nella piattaforma.
I parametri da passare in input alla chiamata sono:
- account_token: il token di autenticazione del tuo account Socialmailer (token);
- account_username: lo username del tuo account Socialmailer (string);
- account_password: la password del tuo account Socialmailer (string);
- message_hash: il codice hash del messaggio per il quale si vuole aggiungere un destinatario (token);
- recipient_stream: File ZIP binario in Base64 di contatti in formato CSV contenente dei campi statici nella prima riga che vengono riconosciuti da Socialmailer e permettono di caricare i dati in rubrica e aggiungerli come destinatari al messaggio unificato (base64BinaryFile);
Il campo recipient_stream è un campo composito definito all'interno del file di definizione WSDL del web service e dentificati dal tag tns (this name space).
Esso deve riportare la seguente struttura:
- filename: Nome del file (string);
- data: Contenuto binario del file in Base64 (base64Binary);
In output la funzione restituisce:
- encoding: il charset di codifica della risposta (string);
- status: il valore dello stato restituito risposta (integer);
- message: la descrizione dello stato restituito dalla risposta (string);
- contacts_hash: Array con i codici hash dei contatti inseriti in rubrica e aggiunti come destinatari del messaggio (contactsHashList, tipo di dato composito definito nel WSDL);
Il campo contacts_hash presente nella risposta della funzione è formato da una lista di dati di tipo contactHashData.
Il campo di tipo contactHashData è un campo composito definito all'interno del file di definizione WSDL del web service e identificato dal tag tns (this name space) così costituito:
- hash: Hash del contatto (token);
- email: Indirizzo email del contatto (string);
- return_insert: Esito dell'inserimento del contatto (returnInsertValues, tipo di dato composito definito nel WSDL);
- return_recipient: Esito della definizione del destinatario (returnRecipientValues, tipo di dato composito definito nel WSDL);
Alcuni campi presenti nella risposta della funzione costituita da una lista di dati di tipo contactHashData sono campi compositi definiti all'interno del file di definizione WSDL del web service.
Sono identificati dal tag tns (this name space) e riportano un elenco di valori predefiniti che possono essere assunti.
Essi sono:
- returnInsertValues: risposte possibili alla richiesta di inserimento di un contatto all'interno della rubrica di Socialmailer;
- returnRecipientValues: risposte possibili alla richiesta di aggiunta di un contatto ai destinatari di un messaggio unificato nella piattaforma Socialmailer;