Gruppi Rubrica | SmsHosting.it
icon_qa
INTRODUZIONE API REST

Usi l'app Postman?
 

GRUPPI RUBRICA

Lista gruppi

Lista dei gruppi della rubrica

URI

GET https://api.smshosting.it/rest/api/phonebook/group/list

Richiesta

ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

La chiamata ritorna una lista con i gruppi presenti in rubrica.

Il gruppo NOTASSIGNED è generato automaticamente per ogni utente e non può essere rimosso.

Ogni gruppo è descritto dalle seguenti proprietà:

ProprietàDescrizione
id Id interno del gruppo
name Nome del gruppo
contactCount Numero di contatti presenti nel gruppo

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.smshosting.it/rest/api/phonebook/group/list
[
   {
      "id":-1,
      "name":"NOTASSIGNED",
      "contactCount":0
   },
   {
      "id":1947,
      "name":"Amici",
      "contactCount":1
   },
   {
      "id":13197,
      "name":"Calcetto",
      "contactCount":1
   }
]

Dettaglio gruppo

Anagrafica di un gruppo

URI

GET https://api.smshosting.it/rest/api/phonebook/group/{id}

Richiesta

ParametroObbligatorioTipoDescrizione
id Si (parametro da specificare nell'URI) String Id interno del gruppo

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
401 Credenziali non valide
404 Gruppo non trovato
405 Metodo HTTP non consentito
500 Errore generico

Proprietà gruppo:

ProprietàDescrizione
id Id interno del gruppo
name Nome del gruppo
contactCount Numero di contatti presenti nel gruppo

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.smshosting.it/rest/api/phonebook/group/1947
   {
      "id":1947,
      "name":"Amici",
      "contactCount":1
   }

Contatti di un gruppo

Lista dei contatti di un dato gruppo

URI

GET https://api.smshosting.it/rest/api/phonebook/group/{id}/contacts

Richiesta

ParametroObbligatorioTipoDescrizione
id Si (parametro da specificare nell'URI) Integer Id interno del gruppo
offset No Integer

Posizione del primo risultato che verrà restituito.

Esempio:

Se la ricerca trova 100 contatti, il campo offset viene valorizzato a 50 ed il campo limit a 10 verranno restituiti i contatti da 51 a 60.

Default : 0

limit No Integer

Numero di risultati che verranno restituiti.

Default : 20

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi

I possibili errorMsg sono:

NO_PARAMS - Parametro name mancante

401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

La chiamata ritorna una lista con di contatti presenti in rubrica.

ProprietàDescrizione
contacts

Lista di contatti

Per il dettaglio delle proprietà di ogni singolo contatto vedi la funzione Dettaglio contatto.

metadata

Metadata utili per la paginazioni

Per maggiori dettagli sul funzionamento della paginazione visita la pagina dedicata

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.smshosting.it/rest/api/phonebook/group/1947/contacts
{
   "metadata":{
      "count":1,
      "offset":0,
      "limit":20
   },
   "contacts":[
      {
         "msisdn":"393480000000",
         "name":"Mario",
         "lastname":"Rossi",
         "address":"via Italia 1",
         "city":"Roma",
         "postCode":00144,
         "province":"RM",
         "country":"IT",
         "email":"mario.rossi@fake.it",
         "homePhoneNumber":"",
         "groups":[
            {
               "id":13197,
               "name":"Amici"
            },
            {
               "id":1947,
               "name":"Lavoro"
            }
         ]
      }
   ]
}

Nuovo gruppo

Aggiungere gruppo in rubrica

URI

POST https://api.smshosting.it/rest/api/phonebook/group

Richiesta

  Il "Content-Type" per le richieste POST deve essere "application/x-www-form-urlencoded"
ParametroObbligatorioTipoDescrizione
name Si String Nome del gruppo

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi

I possibili errorMsg sono:

BAD_GROUP_NAME - Nome del gruppo non valido

GROUP_ALREADY_EXISTS - Esiste già un gruppo con questo nome

401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

In caso il gruppo venga creato correttamente (HTTP status 200) viene restituito il dettaglio del gruppo

ProprietàDescrizione
id Id interno del gruppo
name Nome del gruppo
contactCount Numero di contatti presenti nel gruppo

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET -XPOST https://api.smshosting.it/rest/api/phonebook/group \
-d "name=Amici"
{
   "id":1947,
   "name":"Amici",
   "contactCount":0
}

Aggiorna gruppo

Modificare un gruppo in rubrica

URI

PUT https://api.smshosting.it/rest/api/phonebook/group/{id}

Richiesta

  Il "Content-Type" per le richieste POST deve essere "application/x-www-form-urlencoded"
ParametroObbligatorioTipoDescrizione
id Si (parametro da specificare nell'URI) Integer Id interno del gruppo
name Si String Nome del gruppo

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi

I possibili errorMsg sono:

BAD_GROUP_NAME - Nome del gruppo non valido

GROUP_ALREADY_EXISTS - Esiste già un gruppo con questo nome

401 Credenziali non valide
404 Gruppo non trovato
405 Metodo HTTP non consentito
500 Errore generico

In caso il gruppo venga creato correttamente viene restituito lo stato HTTP status 200

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET -XPUT https://api.smshosting.it/rest/api/phonebook/group/1947 \
-d "name=Amici Calcetto"
HTTP status 200

Elimina gruppo

Eliminare un gruppo in rubrica

URI

DELETE https://api.smshosting.it/rest/api/phonebook/group/{id}

Richiesta

ParametroObbligatorioTipoDescrizione
id Si (parametro da specificare nell'URI) Integer Id interno del gruppo
delete_contacts No Boolean

Possibili varori:true/false
Se valorizzato a true saranno eliminati tutti i contatti che appartengono solo a questo gruppo.

Default: false

Risposta

HTTP Status Code

CodiceDescrizione
204 ok
401 Credenziali non valide
404 Gruppo non trovato
405 Metodo HTTP non consentito
500 Errore generico

In caso il gruppo venga eliminato correttamente viene restituito lo stato HTTP status 200

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET -XDELETE https://api.smshosting.it/rest/api/phonebook/group/1947?delete_contacts=true
HTTP status 204