Web Services interface Specifiche tecniche

Транскрипт

1 i-contact srl via monetti Belluno tel fax p.i./c.f Web Services interface Specifiche tecniche Introduzione SmsHosting fornisce l'accesso ai propri sistemi tramite un'interfaccia web service che consente alle applicazioni l'invio di SMS ai cellulari,la gestione della rubrica e la ricezione di informazioni sul proprio profilo. Per utilizzare le specifiche descritte in questo documento è necessario avere un account attivo su smshosting.it. 2.WSDL e Web Service URL SmsHosting rende disponibili tre web services per interfacciarsi ai propri sistemi. I WSDL di tali servizi sono raggiungibili ai seguenti indirizzi: I rispettivi end point sono: Nei prossimi capitoli verrà fornita una dettagliata descrizione delle operazioni esposte dai tre web services.

2 3.Manage Sms WS 3.1. Il Web serivice Manage Sms espone i metodi per la gestione degli sms da re moto. 3.2.Operazioni Le operazioni messe a disposizione sono le seguenti: a)send Consente di inviare un messaggio ad una determinata lista di numeri e/o gruppi presenti in rubrica in modo immediato o differito. Di seguito viene proposta una richiesta SOAP che consente di inviare un sms immediato al numero xmlns:man=" <man:sendpayload> <username>my-username</username> <password>my-password</password> <from>mittente</from> <numbers> <number> </number> </numbers> <text>testo del messaggio</text> <transactionid> codice-transazione </transactionid> </man:sendpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo send. Parametro Obbligatorio username Account username password Account password numbers Numeri di cellulare. Vedi paragrafo 7.1 per la Msisdn[] definizione del complextype Msisdn. groups [] mi di gruppi presenti in rubrica text Testo del messaggio. Se il messaggio supera i 160 caratteri vengono inviati più sms concatenati fino ad una massimo di 5. (Per i dettagli lfabeto.html) from Mittente del messaggio. (Defaul: mittente configurato nel proprio profilo) Il formato permesso è: yyyymmddhhmmz datetime Se questo parametro viene specificato il messaggio verrà inviato nel giorno e nell'ora indicati. (Ad esempio indica il 01/03/2009 ore 13:51 riferito al GMT +1)

3 transactionid Un identificatore personale. E' utile assegnare a tutti gli sms inviati con una chiamata lo stesso transaction id in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. Una possibile risposta del metodo send potrebbe essere questa: <ns2:sendresponse xmlns:ns2=" sms.ws.sms.icontact/"> <></> <results> <internalid>124501</internalid> <msisdn> <number> </number> </msisdn> <status>pending</status> <transactionid> codice-transazione </transactionid> </results> </ns2:sendresponse> La risposta è composta principalmente da tre parti. Dal campo che riporta l'esito della chiamata, dal campo in cui è indicato un eventuale messaggio di informazione e dal campo Result che restituisce lo stato dei messaggi inviati. Result[] Sarà restituito un oggetto Result per ogni sms inserito. Vedi paragrafo 6,2 per la definizione del complextype Result. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo send. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADSENDERID NOCREDIT BADDATE BADTRANSACTIONID BADLOGIN Errore sconosciuto Mittente (parametro from) non corretto. Credito non sufficiente. Formatto o valore non corretto del parametro datetime Formatto del transaction id non corretto. Username o password non corretti.

4 MISSINGTEXT Testo del messaggio errato. Result status (vedi il paragrafo 7.2) Codice PENDING SENT NOSENT DELIVERED NOTDELIVERED NOTINSERTED Ok. Sms in coda per l'invio. Ok. Sms inviato all'operatore. Ko. Sms non inviato all'operatore. Ok. Sms consegnato al cellulare. Ko. Sms non consegnato al cellulare. Ko. Sms non inserito nel gateway. Result statusdetail (vedi paragrafo 7.2) Codice DUPLICATESMS BADNUMBERFORMAT Sms già inserito nelle ultime 24 ore. Questo è un errore dell'antispam. Formatto del numero di cellulare non corretto (vedi la proprietà number dell'oggetto Msisdn) b)testsend Consente di testare l'invio di un messaggio ad una determinata lista di numeri e/o gruppi presenti in rubrica. Questo medotoè utile nella fase di test in quanto consente di simulare la chiamata di invio Sms senza effettuare veramente l'inserimento del messaggio. Le Soap Request e le Soap Response sono identiche a quelle del metodo send. c)getsmsbyid Consente di visualizzare le informazioni dettagliate dei messaggi data una lista di internalid e/o transactionid. Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli del messaggio con internalid pari a xmlns:man=" <man:smsidpayload> <username>my-username</username> <password>my-password</password> <internalid>124492</internalid> </man:smsidpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getsmsbyid. Parametro Obbligatorio username Account username password Account password internalid int[] Gli id degli sms di cui si vuole conoscere lo stato. Questi id sono indicati nella proprietà internalid nell'oggetto Result.

5 transactionid Se questo parametro è specificato vengono restituiti gli stati degli sms aventi come transaction id il valore passato. Una possibile risposta al metodo getsmsbyid potrebbe essere questa: <ns2:getsmsbyidresponse xmlns:ns2=" sms.ws.sms.icontact/"> <></> <smsinfo> <country>39</country> <from>mittente</from> <id>124492</id> <insertdate> T10:33:46+02:00 </insertdate> <number> </number> <prefix>348</prefix> <status>pending</status> <text>testo del messaggio</text> <transactionid> codice-transazione </transactionid> </smsinfo> </ns2:getsmsbyidresponse> La risposta è composta da tre parti: SmsInfo[] Verrà restituito un oggetto SmsInfo per ogni sms richiesto. Vedi il paragrafo 7.3 per la definizione del complextype SmsInfo. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo getsmsbyid. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti SmsInfo status (vedi paragrafo 7.3)

6 Codice PENDING SENT NOSENT DELIVERED NOTDELIVERED Ok. Sms in coda per l'invio. Ok. Sms inviato all'operatore. Ko. Sms non inviato all'operatore. Ok. Sms consegnato al cellulare. Ko. Sms non consegnato al cellulare. d)getsmsbydate Consente di visualizzare le informazioni dettagliate dei messaggi inseriti in un certo intervallo di date. Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli degli sms inseriti nel circuito di SmsHosting dal 01/08/2008 al 15/08/2008. xmlns:man=" <man:smsdatepayload> <username>my-username</username> <password>my-password</password> <fromdate> </fromdate> <todate> </todate> </man:smsdatepayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getsmsbydate. Parametro Obbligatorio username Account username password Account password fromdate La data di inizio intervallo. Il formato consentito è yyyymmddhhmmz (Ad esempio indica il 01/03/ 2009 ore 13:51 riferito al GMT +1) todate La data di fine intervallo. Il formato consentito è yyyymmddhhmmz (Ad esempio indica il 01/03/ 2009 ore 13:51 riferito al GMT +1) La SOAP Response ha una struttura identica alla SOAP Response dell'operazione getsmsbyid e)getsmsbyparams Consente di visualizzare le informazioni dettagliate dei messaggi inseriti in un certo intervallo di date. Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli degli sms inseriti nel circuito di SmsHosting dal 01/08/2008 al 15/08/2008. xmlns:man="

7 <man:smsparamspayload> <password>my-username</password> <username>my-password</username> < >?</ > <fromdate>?</fromdate> <id>?</id> <number>?</number> <sender>?</sender> <status>?</status> <todate>?</todate> <transactionid>?</transactionid> </man:smsparamspayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getsmsbyparameter. Parametro Obbligatorio username Account username password Account password id int id sms da restituire transactionid id transazione utilizzata per invio con 2sms stato del messaggio SENT / NOSENT /DELIVERED / status NOTDELIVERED /PENDING number numero gsm di destinazione sender mittende dell sms fromdate La data di inizio intervallo. Il formato consentito è yyyymmddhhmmz (Ad esempio indica il 01/03/ 2009 ore 13:51 riferito al GMT +1) todate La data di fine intervallo. Il formato consentito è yyyymmddhhmmz (Ad esempio indica il 01/03/ 2009 ore 13:51 riferito al GMT +1) La SOAP Response ha una struttura identica alla SOAP Response dell'operazione getsmsbyid f)cancelsmsbyid Consente di annullare l'invio degli sms non ancora processati. Gli sms da annullare sono passati tramite una lista di internalid e/o transactionid. Di seguito viene proposta una richiesta SOAP che consente di annullare il messaggio con internalid pari a xmlns:man=" <man:smsidpayload> <username>my-username</username>

8 <password>my-password</password> <internalid>124492</internalid> </man:smsidpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo cancelsmsbyid. Parametro Obbligatorio username Account username password Account password internalid int[] Gli id degli sms da annullare. Questi id sono indicati nella proprietà internalid nell'oggetto Result. transactionid Se questo parametro è specificato vengono annullati gli sms aventi come transaction id il valore passato. Una possibile risposta al metodo cancelsmsbyid potrebbe essere questa: <ns2:cancelsmsbyidresponse xmlns:ns2=" sms.ws.sms.icontact/"> <></> <smsinfo> <country>39</country> <from>mittente</from> <id>124492</id> <insertdate> T10:33:46+02:00 </insertdate> <number> </number> <prefix>348</prefix> <status>nosent</status> <text>testo del messaggio</text> <transactionid> codice-transazione </transactionid> </smsinfo> </ns2:cancelsmsbyidresponse> La risposta è composta da tre parti: SmsInfo[] Verrà restituito un oggetto SmsInfo per ogni sms annullato. Vedi il paragrafo 7.3 per la definizione del complextype SmsInfo. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo cancelsmsbyid. OperationResult

9 FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti SmsInfo status (vedi paragrafo 7.3) Codice PENDING SENT NOSENT DELIVERED NOTDELIVERED Ok. Sms in coda per l'invio. Ok. Sms inviato all'operatore. Ko. Sms non inviato all'operatore. Ok. Sms consegnato al cellulare. Ko. Sms non consegnato al cellulare. 4.Manage PhoneBook WS 4.1. Il web service ManagePhoneBook consente di gestire completamente la rubri ca da remoto. 4.2.Operazioni Le operazioni messe a disposizione solo le seguenti: a)getgroups Consente di visualizzare i gruppi presenti in rubrica per un dato utente. Di seguito viene proposta una richiesta SOAP che consente di visualizzare i gruppi presenti in rubrica. xmlns:phon=" <phon:getgroupspayload> <username>my-username</username> <password>my-password</password> </phon:getgroupspayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getgroups. Parametro Obbligatorio username Account username Account password. La password deve essere password passata in chiaro oppure encodata MD5.

10 Una possibile risposta del metodo send potrebbe essere questa: <ns2:getgroupsresponse xmlns:ns2=" book.ws.sms.icontact/"> <></> <groups> <description/> <name>notassigned</name> </groups> <groups> <description>gws1</description> <name>gws1</name> </groups> </ns2:getgroupsresponse> La risposta è composta da tre parti: contactcroup[] Verrà restituito un oggetto ContactGroup per ogni gruppo presente. Vedi il paragrafo 7.4 per la definizione del complextype ContactGroup. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo getgroups. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti b)getcontactofgroup Consente di visualizzare i contatti associati ad un determinato gruppo. Di seguito viene proposta una richiesta SOAP che consente di visualizzare i contatti associati al gruppo testws. xmlns:phon="

11 <phon:contactsofgrouppayload> <username>my-username</username> <password>my-password</password> <groupname>testws</groupname> </phon:contactsofgrouppayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getcontactsofgroups. Parametro Obbligatorio username Account username Account password. La password deve essere passata in chiaro oppure encodata MD5. password groupname Identificativo del gruppo Una possibile risposta del metodo getcontactsofgroup potrebbe essere questa: <ns2:getcontactsofgroupresponse xmlns:ns2=" <></> <contacts> <address>via Roma 56</address> <city>roma</city> <country>it</country> < /> <groupsname>testws</groupsname> <lastname>rossi</lastname> <mobilephonenumber> </mobilephonenumber> <name>mario</name> <postcode>0</postcode> <province>rm</province> </contacts> </ns2:getcontactsofgroupresponse> La risposta è composta da queste tre parti: Contact[] Verrà restituito un oggetto Contact per ogni contatto associato al gruppo. Vedi il paragrafo 7.5 per la definizione del complextype Contact. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo getcontactsofgroups. OperationResult Operazione terminata con successo

12 FAILED è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti c)getcontact Consente di visualizzare un contatto presente in rubrica univocamente identificato dal numero del cellulare. Di seguito viene proposta una richiesta SOAP che consente di visualizzare i dettagli del contatto con numero di cellulare xmlns:phon=" <phon:contactpayload> <username>my-username</username> <password>my-password</password> <mobilephonenumber> </mobilephonenumber> </phon:contactpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getcontact. Parametro Obbligatorio username Account username Account password. La password deve essere passata in chiaro oppure encodata MD5. password mobilephonenumber Numero di cellulare del contatto Una possibile risposta del metodo getcontact potrebbe essere questa: <ns2:getcontactresponse xmlns:ns2=" book.ws.sms.icontact/"> <></> <contact> <address>via Roma 56</address> <city>roma</city> <country>it</country>

13 < /> <groupsname>testws</groupsname> <lastname>rossi</lastname> <mobilephonenumber> </mobilephonenumber> <name>mario</name> <postcode>0</postcode> <province>rm</province> </contact> </ns2:getcontactresponse> La risposta è composta da queste tre parti: Contact Il contatto trovato. Vedi il paragrafo 7.5 per la definizione del complextype Contact. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo getcontact. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti d)addcontact Consente di aggiungere un contatto in rubrica. Di seguito viene proposta una richiesta SOAP che consente di aggiungere un contatto in rubrica associato al gruppo testws. xmlns:phon=" <phon:addcontactpayload> <username>my-username</username> <password>my-password</password> <contact> <address>via Roma 56</address> <city>roma</city> <country>it</country> < ></ > <groupsname>testws</groupsname> <lastname>rossi</lastname>

14 <mobilephonenumber> </mobilephonenumber> <name>mario</name> <province>rm</province> </contact> </phon:addcontactpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo addcontact. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. Contact Vedi il paragrafo 7.5 per la definizione del complex- Contact Type Contact. Una possibile risposta del metodo getcontact potrebbe essere questa: <ns2:addcontactresponse xmlns:ns2=" book.ws.sms.icontact/"> <></> </ns2:addcontactresponse> La risposta è composta da due parti: Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo addcontact. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN CONTACTMISSING BADCONTACTNAME BADCONTACTLASNAME Errore sconosciuto Username o password non corretti Parametro contatto mancante me contatto non valido Cognome contatto non valido

15 BADCONTACTGROUP BADNUMBERFORMAT CONTACTALREADYEXISTS Gruppo non valido Numero di cellulare del contatto non valido Il contatto esiste già e)updatecontact Consente di aggiornare un contatto presente in rubrica. Di seguito viene proposta una richiesta SOAP che consente di aggiornare l'anagrafica del contatto avente numero di cellulare xmlns:phon=" <phon:updatecontactpayload> <username>my-username</username> <password>my-password</password> <contact> <address>via Monte Napoleone</address> <city>milano</city> <country>it</country> < ></ > <groupsname>testws</groupsname> <lastname>rossi</lastname> <mobilephonenumber> </mobilephonenumber> <name>mario</name> <province>mi</province> </contact> </phon:updatecontactpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo updatecontact. Parametro Obbligatorio username Account username password Account password. Vedi il paragrafo 7.5 per la definizione del complex- Contact Contact Type Contact. Una possibile risposta del metodo addcontact potrebbe essere questa: <ns2:updatecontactresponse xmlns:ns2=" phonebook.ws.sms.icontact/"> <> </> </ns2:updatecontactresponse> La risposta è composta da due parti:

16 Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo updatecontact. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN CONTACTMISSING BADCONTACTNAME BADCONTACTLASNAME BADCONTACTGROUP BADNUMBERFORMAT CONTACTNOTEXISTS Errore sconosciuto Username o password non corretti Parametro contatto mancante me contatto non valido Cognome contatto non valido Gruppo non valido Numero di cellulare del contatto non valido Il contatto non esiste f)removecontact Consente di rimuovere un contatto dalla rubrica. Di seguito viene proposta una richiesta SOAP che consente di liminare il contatto con numero di cellulare xmlns:phon=" <phon:removecontactpayload> <username>my-username</username> <password>my-password</password> <mobilephonenumber> </mobilephonenumber> </phon:removecontactpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo removecontact. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. mobilephonenumber Numero di cellulare del contatto.

17 Una possibile risposta del metodo removecontact potrebbe essere questa: <ns2:removecontactresponse xmlns:ns2=" phonebook.ws.sms.icontact/"> <> </> </ns2:removecontactresponse> La risposta è composta da due parti: Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo removecontact. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN CONTACTNOTEXISTS Errore sconosciuto Username o password non corretti Il contatto non esiste g)addgroup Consente di aggiungere un gruppo in rubrica. Di seguito viene proposta una richiesta SOAP che consente di aggiungere in rubrica il gruppo testws. xmlns:phon=" <phon:addgrouppayload> <username>my-username</username> <password>my-password</password> <group> <description> test WS </description> <name>testws</name> </group> </phon:addgrouppayload>

18 Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo addgroup. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. ContactGroup Vedi il paragrafo 7.4 per la definizion del ContactGroup complextype ContactGroup Una possibile risposta del metodo addgroup potrebbe essere questa: <ns2:addgroupresponse xmlns:ns2=" nebook.ws.sms.icontact/"> <> </> </ns2:addgroupresponse> La risposta è composta da due parti: Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo addgroup. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN GROUPMISSING BADGROUPNAME BADGROUPDESCRIPTION GROUPALREADYEXISTS Errore sconosciuto Username o password non corretti Parametro gruppo mancante me gruppo non valido gruppo non valida Il gruppo esiste già h)removegroup Consente di rimuovere un gruppo dalla rubrica. Di seguito viene proposta una richiesta SOAP che consente di eliminare il gruppo testws dalla rubrica.

19 xmlns:phon=" <phon:removegrouppayload> <username>my-username</username> <password>my-password</password> <name>testws</name> </phon:removegrouppayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo removegroup. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. name Identificativo del gruppo Una possibile risposta del metodo removegroup potrebbe essere questa: <ns2:removegroupresponse xmlns:ns2=" book.ws.sms.icontact/"> <> </> </ns2:removegroupresponse> La risposta è composta da due parti: Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo removegroup. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN GROUPNOTEXISTS Errore sconosciuto Username o password non corretti Il gruppo non esiste

20 5.ManageUser WS 5.1. Il web service ManageUser consente di visualizzare le informazioni sul proprio account. 5.2.Operazioni Le operazioni messe a disposizione sono le seguenti: a)getuserinfo Consente di visualizzare le informazioni dettagliate dell'account di un utente comprese quelle sul credito. Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli dell'account my-username. xmlns:man=" <man:userinfopayload> <username>my-username</username> <password>my-password</password> </man:userinfopayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getuserinfo. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. Una possibile risposta del metodo getuserinfo potrebbe essere questa: <ns2:getuserinforesponse xmlns:ns2=" <></> <userinfo> <address>via Roma 56</address> <birthdate> </birthdate> <city>roma</city> <country>it</country> <credit> </credit> < > [email protected] </ > <internationalsms> </internationalsms> <italysms>53632</italysms> <italyprice>0.95</italyprice> <internationalprice>0.06</internationalprice> <lastname>rossi</lastname> <msisdn> </msisdn> <name>mario</name> <phone> </phone> <postcode>30000</postcode> <province>rm</province> <sender>mittente</sender>

21 <taxcode>xxxxxxxxxxxxxxxx</taxcode> <username>my-username</username> <registrationdate> T10:10:15+01:00 </registrationdate> <expirationdate> T10:10:15+01:00 </expirationdate> </userinfo> </ns2:getuserinforesponse> La risposta è composta da tre parti: UserInfo Contiene le informazioni sull'account. Vedi il paragrafo 7.6 per la definizione del complextype UserInfo. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo getuserinfo. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti b) add 2sms Consente di aggiungere un' abilitata all' 2sms per l'account specificato Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli dell'account my-username. xmlns:man=" <man:manage payload> <password>my-username</password> <username>my-password</username> < >[email protected]</ > </man:manage payload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo add 2sms.

22 Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. L' da aggiungere Una possibile risposta del metodo add 2sms potrebbe essere questa: <ns2:add 2smsresponse xmlns:ns2=" <></> </ns2:add 2smsresponse> La risposta è composta da due parti: c) remove 2sms Consente di rimuovere un' abilitata all' 2sms per l'account specificato Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli dell'account my-username. xmlns:man=" <man:manage payload> <password>my-username</password> <username>my-password</username> < >[email protected]</ > </man:manage payload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo remove 2sms. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. L' da rimuovere Una possibile risposta del metodo remove 2sms potrebbe essere questa: <ns2:remove 2smsresponse xmlns:ns2=" <></>

23 </ns2:remove 2smsresponse> La risposta è composta da due parti: d) insertsubuser Consente di inserire sub utenti per gli account di tipo rivenditore Di seguito viene proposta una richiesta SOAP che consente di creare l'account my-subusername. xmlns:man=" <man:insertsubuserpayload> <resellerpassword>resellerusername</resellerpassword> <resellerusername>password</resellerusername> <username>my-subusername</username> <password>my-password</password> <name>jon</name> <lastname>smith</lastname> <sender>jon</sender> <taxcode>bbbxxx77e23a757y</taxcode> <birthdate> </birthdate> </man:insertsubuserpayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getuserinfo. Parametro Obbligatorio resellerusername resellerpassword Username dell account rivenditore al quale associare il nuovo sub utente Password dell account rivenditore al quale associare il nuovo sub utente. La password deve essere passata in chiaro oppure encodata MD5. username Account username password name lastname Account password. La password deve essere passata in chiaro oppure encodata MD5. me della persona associata all account Cognome della persona associata all account

24 sender vatnumber Solo se azienda businessname Solo se azienda taxcode per le comunicazioni relative all account mittente di default utilizzato dall account Partita iva dell azienda associata all account Ragione sociale dell azienda associata all account Codice fiscale personale o dell azienda country nazione di residenza province provincia di residenza city comune di residenza address indirizzo di residenza postcode codice postale phone telefono della persona o azienda msisdn cellulare della persona o azienda birthdate Solo se privato Data di nascita della persona nel formato ddmmyyy Una possibile risposta del metodo insertsubuser potrebbe essere questa: <ns2:insertsubuserresponse xmlns:ns2=" <></> </ns2:insertsubuserresponse> La risposta è composta da due parti: Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo insertsubuser. OperationResult

25 FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti 6. Sms received WS 6.1. Il web service SmsReceived consente di visualizzare le informazioni sugli Sms ricevuti mediante il servizio forward sms ( 6.2.Operazioni Le operazioni messe a disposizione sono le seguenti: a)getsmsbydate Consente di visualizzare le informazioni dettagliate dei messaggi ricevuti in un certo intervallo di date. Di seguito viene proposta una richiesta SOAP che consente di ricevere i dettagli dell'account my-username. xmlns:ser=" <ser:smsdatepayload> <password>my-ysername</password> <username>my-password</username> <fromdate> </fromdate> <todate> </todate> </ser:smsdatepayload> Nella tabella sottostante vengono riportati tutti i possibili parametri del metodo getsmsbydate. Parametro Obbligatorio username Account username password Account password. La password deve essere passata in chiaro oppure encodata MD5. fromdate La data di inizio intervallo. Il formato consentito è yyyymmddhhmmz (Ad esempio indica il 01/03/2009 ore 13:51 riferito al GMT +1)

26 todate La data di fine intervallo. Il formato consentito è yyyymmddhhmmz (Ad esempio indica il 01/03/2009 ore 13:51 riferito al GMT +1) Una possibile risposta del metodo getsmsbydate potrebbe essere questa: <ns2:getsmsbydateresponse xmlns:ns2=" <></> <smsinfo> <country>+39</country> <id>34601</id> <number> </number> <prefix>347</prefix> <receivedate> t10:10:15+01:00</receivedate> <text>ok</text> </smsinfo> <smsinfo> <country>+39</country> <id>33377</id> <number> </number> <prefix>347</prefix> <receivedate> t18:11:47+01:00</receivedate> <text>ciao</text> </smsinfo> </ns2:getsmsbydateresponse> La risposta è composta da tre parti: SmsInfo[] Verrà restituito un oggetto SmsInfo per ogni sms richiesto. Codici di Ritorno: Vengono riportati di seguito i possibili codici di ritorno restituiti dal metodo getsmsbydate. OperationResult FAILED Operazione terminata con successo è verificato un problema nella chiamata. Il dettaglio del problema che si è verificato è indicato nel campo OperationDetail GENERICERROR BADLOGIN Errore sconosciuto Username o password non corretti

27 7.Definizione ComplexType Viene riportata di seguito la definizione dei ComplexType utilizzati nei web service. 7.1.Msisdn Parametro Obbligatorio customerid number 7.2.Result Un identificativo personale degli sms. Questo parametro è utile per gestire l'oggetto Result. Numero di cellulare. Per esempio oppure Parametro Obbligatorio Msisdn Msisdn L'originale Msisdn ricevuto in input internalid L'id di smshosting associato all'sms status Codice con lo stato principale dell'sms. Vedi la tabella status per i dettagli statusdetail Codice con il dettaglio dello stato dell'sms. Vedi la tabella statusdetail per i dettagli. transactionid Il transaction id originale se passato in input. Altrimenti un transaction id generato. 7.3.SmsInfo Dati per sms inviati Parametro Obbligatorio id InternalId del messaggio. country Parte del numero a cui è stato inviato il messaggio prefix Parte del numero a cui è stato inviato il messaggio number Parte del numero a cui è stato inviato il messaggio from Mittente del messaggio status Stato del messaggio. text Testo del messaggio Data inserimento del messaggio nel circuito di smshosting insertdate Date senddate Date Data di invio del messagio deliverydate Date Data di consegna del messagio Transaction id con il quale il messaggio è stato inserito. transactionid Dati per sms ricevuti Parametro Obbligatorio id InternalId del messaggio. country Parte del numero mittente del messaggio prefix Parte del numero mittente del messaggio number Parte del numero mittente del messaggio text Testo del messaggio receivedate Date Data ricezione del messaggio

28 7.4.ContactGroup Parametro Obbligatorio name me del gruppo description del gruppo 7.5.Contact Parametro Obbligatorio mobilephonenumber Numero di cellulare del contatto name me del contatto lastname Cognome del contatto address Indirizzo city città postcode Int Cap province Provincia country Nazione Numero telefonico abitazione del contatto homephonenumber groupsname [] me dei gruppi associati al contatto. 7.6.UserInfo Parametro Obbligatorio name me lastname Cognome username Username Businessname Ragione sociale address Indirizzo city città postcode Int Cap province Provincia country Nazione birthdate Data di nascita phone Telefonico abitazione msisdn Numero di cellulare sender mittente taxcode Codice fiscale vatnumber Partita iva credit Double Credito italysms Long Numero sms italia internationalsms Long Numero sms internazionali italyprice Long Costo unitario sms italia in EUR

29 internationalprice registrationdate Long Date Costo unitario sms internazionale (esclusa interconnessione) in EUR Data di registrazione dell account expirationdate Date Data di scadenza dell account