Dati tecnici - TelephoneVox

PARAMETRI PER API
ENGLISH AVAILABLE: ASK TO [email protected]
Per realizzare il modulo d'ordine nel vostro sito web potete aiutarvi osservando come abbiamo
organizzato il nostro: www.telephonevox.com/preventivo.php
I parametri attualmente sono stati nominati con termini in italiano, ma se necessario possiamo
fornire una versione con termini in inglese.
E' da considerare che non tutti i parametri sono obbligatori, pertanto è possibile integrare una
quantità ridotta di parametri in base alle proprie necessità o al tempo a propria disposizione.
ATTENZIONE: rispettare maiuscolo e minuscole
In rosso specifichiamo i parametri che consideriamo obbligatori. Quelli non contrassegnati con la
dicitura "OBBLIGATORIO" sono parametri facoltativi.
URL API: http://www.telephonevox.com/api/api.telephonevox.php
PARAMETRI INIZIALI DI CONFIGURAZIONE
QUELLI CHE SEGUONO SONO I PARAMETRI DI CONFIGURAZIONE INIZIALI
idCliente: (specificare il vostro numero identificativo utente) // OBBLIGATORIO
password: (specificare la vostra password assegnatavi) // OBBLIGATORIO
linguasito: italiano/inglese // OBBLIGATORIO
Parametro che indica la lingua scelta dall'utente nel sito/piattaforma "ospitante". Dobbiamo conoscere questo valore
in quanto per i siti/piattaforme in lingua inglese offriamo alcune scelte aggiuntive che non possiamo offrire invece per
i siti/piattaforme in italiano. Per esempio, se il sito/piattaforma è in inglese, allora usare il valore "inglese".
ACTION: INSERT/VOICES/SOUNDTRACK // OBBLIGATORIO
Parametro fisso che indica l’azione API da svolgere. Indicare la dicitura "INSERT" per passare gli ordini, compilando i
parametri "dettagli messaggio" e "dettagli carrello" indicati di seguito. Indicare la dicitura "VOICES" per ricevere la lista
degli speaker disponibili e le rispettive demo. Indicare la dicitura "SOUNDTRACK" per ricevere la lista delle basi
musicali disponibili e le rispettive demo .
PARAMETRI DETTAGLI MESSAGGIO
QUELLI CHE SEGUONO SONO I PARAMETRI RELATIVI ALLE SPECIFICHE TECNICO ARTISTICHE DEI MESSAGGI DA
ORDINARE, DA PASSARE IN POST. NEL CASO SI VOLESSERO INSERIRE PIU’ MESSAGGI, SOSTITUIRE IL NUMERO 1
INDICATO NEL PARAMETRO CON IL NUMERO 2, 3, 4, … PER OGNI MESSAGGIO/FILE.
NEL CASO IN CUI IL VALORE DEL PARAMETRO NON VENISSE SPECIFICATO (PER QUELLI NON OBBLIGATORI) VERRA'
CONSIDERATO UN VALORE STANDARD (VEDI SPECIFICA SOTTO OGNI PARAMETRO).
testo-1: (campo libero: inserire testo messaggio) // OBBLIGATORIO
Parametro per l'invio del testo del messaggio da registrare
scegliPrezzo-1: aCarattere/aMessaggio
Parametro per la scelta del prezzo da applicare al messaggio. Potete decidere se pagare questo messaggio applicando
un prezzo a carattere o a messaggio. Il prezzo "a messaggio" è limitato per messaggi di massimo 150 caratteri, se il
messaggio supererà tale quantitativo sarà applicato un sovrapprezzo. Per maggiori informazioni rivolgetevi al nostro
commerciale.
Default: aCarattere
ATTENZIONE:
-OBBLIGATORIO ALMENO UNO DEI SEGUENTI PARAMETRI
-ALMENO UNO DEI SEGUENTI PARAMETRI DEVE AVERE VALORE DIVERSO DA "VUOTO"
linguaitaliana-1: italiano/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua italiana. Indicare la dicitura “italiano” se sì, lasciare vuoto per
no.
linguainglese-1: inglese/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua inglese. Indicare la dicitura “inglese” se sì, lasciare vuoto per
no.
linguafrancese-1: francese/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua francese. Indicare la dicitura “francese” se sì, lasciare vuoto
per no.
linguatedesco-1: tedesco/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua tedesco. Indicare la dicitura “tedesco” se sì, lasciare vuoto per
no.
linguaspagnolo-1: spagnolo/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua spagnolo. Indicare la dicitura “spagnolo” se sì, lasciare vuoto
per no.
linguaportoghese-1: portoghese/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua portoghese. Indicare la dicitura “portoghese” se sì, lasciare
vuoto per no.
linguarussa-1: russo/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua russa. Indicare la dicitura “russo” se sì, lasciare vuoto per no.
linguagiapponese-1: giapponese/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua giapponese. Indicare la dicitura “giapponese” se sì, lasciare
vuoto per no.
linguacinese-1: cinese/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua cinese. Indicare la dicitura “cinese” se sì, lasciare vuoto per
no.
linguaarabo-1: arabo/(vuoto)
Parametro per la richiesta di lettura messaggio in lingua araba. Indicare la dicitura “arabo” se sì, lasciare vuoto per no.
sesso-1: maschile/femminile
Parametro per la scelta del sesso dello speaker
Default: femminile
beep-1: si/no
Parametro per indicare se al termine del messaggio va inserito un segnale acustico (il classico "beep" a fine messaggio)
Default: no
numeroFiles-1: unoperlingua/unounico // UTILIZZABILE SOLO SE E' STATO ATTIVATO PIU' DI UN PARAMETRO LINGUA
Parametro per la scelta della quantità di files da produrre in base alla quantità di lingue richieste. E' possibile
richiedere un file per ogni lingua richiesta oppure un unico file audio che contenga tutte le lingue richieste.
Default: unounico
presenzaBase-1: nessuna_base/Base_che_termina_con_il_parlato/Base_che_prosegue_oltre_il_parlato
Parametro per richiedere una base musicale in sottofondo al messaggio. Le scelte sono tre: "nessuna base musicale",
"base musicale che termina insieme al parlato della speaker" oppure "base musicale che prosegue oltre il parlato della
speaker".
Default: nessuna_base
genereBase-1: classica/moderna/natalizia/indicoBase/caricoBase
Parametro per la scelta della base di sottofondo al messaggio. Le scelte sono 5: "una base di musica classica dal nostro
catalogo", "una base di musica moderna dal nostro catalogo", "una base di musica natalizia dal nostro catalogo", "una
canzone da specificare indicando autore e titolo", "una base musicale di cui si dispone il file audio".
Default: classica
durataBase-1: (campo libero: specificare la durata della base oltre il parlato, in secondi)
Paramentro per specificare quanti secondi deve proseguire la base musicale oltre l'ultima parola pronunciata dalla
speaker.
Default: 5 secondi
numeroBase-1: (specificare il numero identificativo della base: vedi lista fornita tramite apposita API)
Parametro per specificare il numero identificativo della base musicale del nostro catalogo scelta come sottofondo.
Vedere lista fornita tramite apposita API.
Default: 1
titoloBase-1: (campo libero: specificare autore e titolo del brano richiesto o nome del file della base da caricare) //
OBBLIGATORIO SE IL PARAMETRO genereBase-1 HA VALORE "indicoBase"
Parametro per specificare il nome dell'autore e del brano richiesto come sottofondo musicale.
percorsoUploadFileBase-1: (campo libero: specificare il percorso della base da caricare, ad esempio
http://www.miosito.it/base/ordine_1234.zip) // OBBLIGATORIO SE IL PARAMETRO genereBase-1 HA VALORE
"caricoBase"
Parametro per specificare il percorso del file da caricare come sottofondo musicale.
vocemaschilelinguaitaliana-1: (lasciare vuoto per “indifferente” o specificare il numero identificativo dello speaker:
vedi lista fornita tramite apposita API) // UTILIZZABILE SOLO SE IL PARAMETRO sesso-1 HA VALORE "MASCHILE"
Parametro per specificare il numero identificativo dello speaker maschile italiano preferito
Default: Indifferente
vocefemminilelinguaitaliana-1: (lasciare vuoto per “indifferente” o specificare il numero identificativo dello speaker:
vedi lista fornita tramite apposita API) // UTILIZZABILE SOLO SE IL PARAMETRO sesso-1 HA VALORE "FEMMINILE"
Parametro per specificare il numero identificativo della speaker femminile italiana preferita
Default: Indifferente
vocemaschilelinguainglese-1: (lasciare vuoto per “indifferente” o specificare il numero identificativo dello speaker:
vedi lista fornita tramite apposita API) // UTILIZZABILE SOLO SE IL PARAMETRO linguasito HA VALORE “inglese” E IL
PARAMETRO sesso-1 HA VALORE "MASCHILE"
Parametro per specificare il numero identificativo dello speaker maschile inglese preferito
Default: Indifferente
vocefemminilelinguainglese-1: (lasciare vuoto per “indifferente” o specificare il numero identificativo dello speaker:
vedi lista fornita tramite apposita API) // UTILIZZABILE SOLO SE IL PARAMETRO linguasito HA VALORE “inglese” E IL
PARAMETRO sesso-1 HA VALORE "FEMMINILE"
Parametro per specificare il numero identificativo della speaker femminile inglese preferita
Default: Indifferente
traduzioneTesto-1: fornisco_le_traduzioni/traducete_voi_grazie // UTILIZZABILE SOLO SE E' STATO ATTIVATO UN
PARAMETRO LINGUA RELATIVO AD UNA LINGUA DIVERSA DA QUELLA IN USO NEL SITO/PIATTAFORMA OSPITANTE.
Parametro per specificare se si preferisce fornire la specifica traduzione del testo per le versioni in altre lingue o se si
preferisce avvalersi del servizio gratuito accettando la nostra traduzione.
Default: traducete_voi_grazie
testoTradottoIng-1: (campo libero: inserire la traduzione inglese del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguainglese-1
Parametro per specificare il testo da usare per la versione inglese del messaggio
testoTradottoFra-1: (campo libero: inserire la traduzione francese del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguafrancese1
Parametro per specificare il testo da usare per la versione francese del messaggio
testoTradottoTed-1: (campo libero: inserire la traduzione tedesca del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguatedesco-1
Parametro per specificare il testo da usare per la versione tedesca del messaggio
testoTradottoSpa-1: (campo libero: inserire la traduzione spagnola del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguaspagnolo1
Parametro per specificare il testo da usare per la versione spagnola del messaggio
testoTradottoPor-1: (campo libero: inserire la traduzione portoghese del messaggio) OBBLIGATORIO SE IL
PARAMETRO traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO
linguaportoghese-1
Parametro per specificare il testo da usare per la versione portoghese del messaggio
testoTradottoRus-1: (campo libero: inserire la traduzione russa del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguarusso-1
Parametro per specificare il testo da usare per la versione russa del messaggio
testoTradottoGia-1: (campo libero: inserire la traduzione giapponese del messaggio) OBBLIGATORIO SE IL
PARAMETRO traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO
linguagiapponese-1
Parametro per specificare il testo da usare per la versione giapponese del messaggio
testoTradottoCin-1: (campo libero: inserire la traduzione cinese del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguacinese-1
Parametro per specificare il testo da usare per la versione cinese del messaggio
testoTradottoAra-1: (campo libero: inserire la traduzione araba del messaggio) OBBLIGATORIO SE IL PARAMETRO
traduzioneTesto-1 HA VALORE "FORNISCO_LE_TRADUZIONI" E SE E' STATO ATTIVATO IL PARAMETRO linguaarabo-1
Parametro per specificare il testo da usare per la versione araba del messaggio
PARAMETRI DETTAGLI CARRELLO
QUELLI CHE SEGUONO SONO I PARAMETRI RELATIVI ALLE SPECIFICHE DEFINITIVE VALIDE PER TUTTI I MESSAGGI
INSERITI NEL CARRELLO
numeroMessaggi: (campo libero) // OBBLIGATORIO
Parametro per la specifica del numero di messaggi/file da registrare/creare
codicePromozionale: (campo libero) // OBBLIGATORIO
Parametro per specificare il codice sconto assegnatovi. Per questa informazione potete rivolgervi al nostro
responsabile commerciale.
test: Y/N // OBBLIGATORIO
Parametro per specificare se si stanno eseguendo dei test (e quindi gli ordini non verranno messi in lavorazione),
oppure no
ricevere: Per_posta_(cd_rom)/Per_email
Parametro per specificare il metodo di ricezione dell'ordine che può essere via email o per posta ordinaria
Default: Per_email
tipoFile: Adpcm (microsoft)/Alaw/Ulaw/Dialogic Vox (adpcm)/Wave/Mp3 (standard)
Parametro per specificare il tipo di file da usare per produrre i file audio
Default: Mp3 (standard)
estensioneFile: (campo libero)
Parametro per specificare l'estensione da usare per produrre i file audio
formatoFile: (campo libero)
Parametro per specificare il formato da usare per produrre i file audio
frequenzaFile: (campo libero)
Parametro per specificare la frequenza di campionamento da usare per produrre i file audio
risoluzioneFile: (campo libero)
Parametro per specificare il formato da usare per produrre i file audio)
Pagamento: bonifico/paypal
Parametro per la scelta del metodo di pagamento preferito per questo preventivo. Per maggiori informazioni su
questa scelta è possibile parlare con il nostro responsabile commerciale.
ESEMPI SCHERMATE DI RITORNO ALLA CHIAMATA API (FORMATO JSON)
Caso 1 (errore parametri generali di configurazione-NB lista errori separata dal carattere . (punto))
[
{"Error":"Attenzione, non hai inserito il parametro ACTION."}
]
Caso 2 (errore parametri dettaglio messaggi-NB lista errori separata dal carattere . (punto))
[
{
"Result": "Ordine non inserito",
Numero-ordine": "n.d.",
Error": "Attenzione, non hai inserito il testo nel messaggio 1."
}
]
Caso 3 (errore in convalida ordine da parte del nostro sistema-NB lista errori separata dal carattere . (punto))
[
{
"Result": "Ordine non inserito",
Numero-ordine": "n.d.",
Error": "Errore convalida o fase test."
}
]
Caso 4 (ordine correttamente inserito)
[
{
"Result": "Ordine inserito",
Numero-ordine": "4686"
}
]
ESPORTAZIONE VOCI
ESEMPIO SCHERMATA DI RITORNO ALLA CHIAMATA API (FORMATO JSON)
[
{"Voce":"1","Tipo_voce":"Voce italiana femminile","File_mp3":"http://www.telephonevox.com/voci/1.mp3"},
…
{"Tipo_voce":"Voce inglese maschile","File_mp3":"http://www.telephonevox.com/voci/ingleseMaschile.mp3"},
…
{"Tipo_voce":"Voce arabo maschile","File_mp3":"http://www.telephonevox.com/voci/araboMaschile.mp3"}
]
ESPORTAZIONE BASI MUSICALI
ESEMPIO SCHERMATA DI RITORNO ALLA CHIAMATA API (FORMATO JSON)
[
{"Base":"1","Tipo_base":"classica","Titolo":"Eine kleine nachtmusik (allegro)",
"Autore":"Mozart","File_mp3":"http://www.telephonevox.com/basi/1.mp3"},
…
{"Base":"23","Tipo_base":"moderna","Titolo":"Tender Hand 2","Autore":"Karel
Vagner","Genere":"Pop","File_mp3":"http://www.telephonevox.com/basi/23.mp3"},
…
{"Base":"48","Tipo_base":"natalizia","Titolo":"Auld lang syne","File_mp3":"http://www.telephonevox.com/basi/48.mp3"}
]