Ritorna la lista degli alias configurati.
Gli alias sono i mittenti alfanumerici utilizzabili per l'invio SMS.
Nessun dato richiesto
HTTP Status Code
Codice | Descrizione |
---|---|
200 | ok |
401 | Credenziali non valide |
405 | Metodo HTTP non consentito |
500 | Errore generico |
Dati Alias
Proprietà | Descrizione |
---|---|
id | Identificativo dell'Alias |
alias | stringa identificativa dell'alias |
vatnumber | partiva iva |
taxcode | codice fiscale |
businessname | ragione sociale |
address | indirizzo |
city | comune |
postcode | CAP |
province | provincia |
country | Nazione |
phone | telefono |
pec | indirizzo posta elettronica certificata |
status |
Stato dell'Alias. I possibili stati sono:
|
Esempio:
curl --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/alias/list
[ { "id": 13497,
"alias": "test",
"vatnumber": "01019390259",
"taxcode": "01019390259",
"businessname": "smshosting.it",
"address": "via masi simonetti 48",
"city": "belluno",
"postcode": "32100",
"province": "BL",
"country": "IT",
"email": "info@smshosting.it",
"phone": "043700000",
"pec": "icontact@pcert.it",
"status": "VERIFIED" } ]
Crea un nuovo Alias, questa procedura è obbligatoria per poter utilizzare un mittente personalizzato per l'invio di SMS.
Parametro | Obbligatorio | Tipo | Descrizione |
---|---|---|---|
alias | Si | String |
Stringa identificativa dell'alias. La stringa non può superare gli 11 caratteri. Può contenere solo lettere (a-z) maiuscole o minuscole, numeri, spazi ed i caratteri . _ - & @ * '' |
businessname | Si | String |
ragione sociale dell'azienda da associare all'alias |
address | Si | String | indirizzo della sede dell'azienda da associare all'alias |
city | Si | String |
comune della sede dell'azienda da associare all'alias |
postcode | Si | String | CAP della sede dell'azienda da associare all'alias |
province | Si | String | provincia della sede dell'azienda da associare all'alias (sigla di due lettere) |
country | Si | String |
nazione della sede dell'azienda da associare all'alias. Specificare il codice ISO 3166-1 a due lettere. Ad esempio per l'italia specificare IT |
vatnumber | Si | String | partita IVA dell'azienda da associare all'alias |
Si | String | email dell'azienda da associare all'alias | |
phone | Si | String | telefono dell'azienda da associare all'alias |
taxcode | Si | String | codice fiscale dell'azienda da associare all'alias |
pec | Si | String | posta elettronica certificata da associare all'alias |
HTTP Status Code
Codice | Descrizione |
---|---|
200 | ok |
400 |
Parametri non validi I possibili
BAD_CITY - paramatro city non valido
|
401 | Credenziali non valide |
405 | Metodo HTTP non consentito |
500 | Errore generico |
Dati Alias
In caso di successo verranno restituiti i dati dell'Alias appena creato
Esempio:
curl --user AUTH_KEY:AUTH_SECRET -XPOST https://api.smshosting.it/rest/api/alias \ -d "alias=test" \ -d "vatnumber=01019390259" \ -d "taxcode=01019390259" \ -d "businessname=smshosting.it" \ -d "address=via masi simonetti 48" \
-d "city=belluno" \
-d "postcode=32100" \
-d "province=BL" \
-d "businessname=info@smshosting.it" \
-d "email=IT" \
-d "phone=043700000" \
-d "pec=icontact@pcert.it"
{ "id": 13497,
"alias": "test",
"vatnumber": "01019390259",
"taxcode": "01019390259",
"businessname": "smshosting.it",
"address": "via masi simonetti 48",
"city": "belluno",
"postcode": "32100",
"province": "BL",
"country": "IT",
"email": "info@smshosting.it",
"phone": "043700000",
"pec": "icontact@pcert.it" "status": "VERIFIED" }
Cancella in modo definitivo un Alias.
Nessun parametro richiesto
HTTP Status Code
Codice | Descrizione |
---|---|
200 | ok |
400 |
Parametri non validi I possibili
|
401 | Credenziali non valide |
405 | Metodo HTTP non consentito |
500 | Errore generico |
Esempio:
curl --user AUTH_KEY:AUTH_SECRET -XDELETE https://api.smshosting.it/rest/api/alias/13497