Documentazione AR APIv2 1.0.8 Help

By Phone Number With Cards *

badge Status-TEST

La chiamata di elenco Users e Cards per numero di telefono permette di:

  • Ricevere l'elenco di Utenze e Cards (attive e non), per il numero di telefono indicato;

Richiede in ingresso:

  • Il numero di telefono;

Restituisce:

  • L'elenco di Utenti;

  • L'elenco di Cards;

  • Eventuale Ticket aperto (non ancora risolto), se presente, per la Card;

  • Oppure, se non va a buon fine, la descrizione dell’errore riscontrato;

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/Users/ByPhoneNumberWithCards/{phoneNumber}

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/Users/ByPhoneNumberWithCards/{phoneNumber}

Metodo

GET

Success Response

200 (Success)
204 (No Content)

Error Response

400 (Bad Request)
401 (Unauthorized)
500(Internal Server Error)

Di seguito la struttura dell’Header:

Header

{ "authorization": "Bearer -indicare-qui-Token-fornito-" }

Il numero di telefono va inserito come parametro nell’URL andando a sostituire {phoneNumber}.

Il numero di telefono deve essere codificato (URL-encoded) e NON deve contenere il carattere “/”.

In questo caso il la struttura body di request non è necessaria e rimane vuota:

{ }

Di seguito la struttura della response contenente i valori di ritorno dal sistema:

Response body

{ // Utenze rilevate per il numero di telefono fornito "users": [ { "name": "[string]{nome dell’Utente}", "surname": "[string]{cognome dell’Utente}", "email": "[string]{email univoca e identificativa dell’Utente}", "phoneNumber": "[string]{numero di telefono dell’Utente}" } ], // Cards (attive e non) per le utenze rilevate "cards": [ { "serviceDeviceType": "[string]{nome del tipo di Device per il quale viene erogato il servizio}", "name": "[string]{nome della Card}", "description": "[string]{descrizione della Card}", "codeProduct": "[string]{codice identificativo del prodotto}", "serviceName": "[string]{nome del Servizio fornito}", "serviceCodeProduct": "[string]{codice del Servizio fornito}" "dateActived": "[dateTime]{data/momento di attivazione e validità della Card}", "dateExpired": "[dateTime]{data/momento di scadenza della Card}", // Ticket aperto, se presente per la Card "ticket": { "id": [long]{identificativo univoco del Ticket}, "cardCode": "[string]{codice univoco della CardReleased di appartenenza}", "dateOpened": "[DateTime]{data di apertura del Ticket}", "dateAppointment": "[DateTime]{data appuntamento risoluzione, concordato con il cliente}", "dateClosed": "[DateTime]{data di risoluzione del Ticket}", "dateReplied": "[DateTime]{data di risposta da parte dell’operatore, al Ticket}", "title": "[string]{titolo della problematica riscontrata}", "problemDescription": "[string]{descrizione accurata della problematica riscontrata}", "replySolution": "[string]{risposta di risoluzione dell’operatore}", "feedback": "[string]{resoconto dell’esperienza dell’utente}", "feedbackValue": [int][nullable]{valutazione (da 1 a 5) dell’esperienza dell’utente}, "isTaken": [bool]{indica se il Ticket è stato preso in carico dall’Operatore}, "hasAppointment": [bool]{indica se il Ticket ha un appuntamento di risoluzione fissato}, "isClosed": [bool]{indica se il Ticket è chiuso (true) o aperto (false)}, "isResolved": [bool]{indica se il Ticket è risolto (true) o meno (false)} } } ] }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/Users/ByPhoneNumberWithCards/3334441212

Request body

{ }

In caso di Successo il sistema ritorna il seguente modello JSON:

Response body

{ // Utenze rilevate per il numero di telefono fornito "users": [ { "name": "Mario", "surname": "Rossi", "email": "mario.rossi@libero.it", "phoneNumber": "3317291048" }, { "name": "Mario", "surname": "Rossi", "email": "rossim@gmail.com", "phoneNumber": "3317291048" } ], // Cards (attive e non) per le utenze rilevate "cards": [ { "serviceDeviceType": "Computer", "name": "SERVIZIO COMPUTER", "description": "SERVIZIO COMPUTER", "codeProduct": "SIRTIE12COMPUTE", "serviceName": "SERVIZIO COMPUTER", "serviceCodeProduct": "SIRTIE12COMPUTE" "dateActived": "2025-10-23T12:00:00.000", "dateExpired": "2026-10-23T12:00:00.000", "ticket": null }, { "serviceDeviceType": "Smartphone", "name": "SERVIZIO SMART", "description": "SERVIZIO SMART", "codeProduct": "SIRTIE12SMART", "serviceName": "SERVIZIO SMART", "serviceCodeProduct": "SIRTIE12SMART" "dateActived": "2025-11-25T14:00:00.000", "dateExpired": "2026-11-25T14:00:00.000", // Ticket aperto, se presente per la Card "ticket": { "id": 46788, "cardCode": "218796CDD0DC47DB", "dateOpened": "2025-12-10T17:45:59.0300711", "dateClosed": null, "dateAppointment": "2023-12-11T12:00:00.0300711", "dateReplied": null, "title": "Le app non funzionano (Whatsapp, Instagram, Facebook)", "problemDescription": "Non riesco più ad utilizzare lo smartphone, lo schermo è tutto blu.", "replySolution": null, "feedback": null, "feedbackValue": null, "isTaken": true, "hasAppointment": true, "isClosed": false, "isResolved": false } } ] }

In caso di Errore il sistema ritorna il seguente modello JSON:

Response

Status: 400 Bad Request

{ "error": "Numero di telefono non valido (encoding mancante o '/' rilevato)." }

Errori Riscontrabili

Di seguito la lista che indica gli errori che possono essere riscontrati:

Codice

Descrizione

400
(BadRequest)

I dati in ingresso non sono corretti o non sono correttamente formattati. Viene restituita la descrizione dell’errore nel dettaglio.

401
(Unauthorized)

Il codice Token fornito non è valido. L’autenticazione non è andata a buon fine.

500
(Internal Server Error)

Il server ha riscontrato un errore inaspettato, generalmente esula dal tipo di request e si verifica per problemi assoggettabili al sistema.

17 novembre 2025