Ricezione Sms

> Ricerca SMS ricevuti
> Lista servizi di ricezione

Ricerca SMS ricevuti

Ricerca degli sms ricevuti con il servizio di ricezione "Forward sms".

URI

GET https://api.amm.cloud/sms/v2/received/search

Richiesta

Parametro	Obbligatorio	Tipo	Descrizione
from	No (Obbligatorio valorizzare almeno uno tra il campo from, simIdRef, fromDate e toDate)	String	Mittente degli sms ricevuti. Deve essere un numero di cellulare compreso di prefisso internazionale. È possibile specificare più numeri di telefono separandoli con il carattere virgola ",". Ad esempio: 393481234567 oppure 393481234567,393481234568,393481234568
simIdRef	No (Obbligatorio valorizzare almeno uno tra il campo from, simIdRef, fromDate e toDate)	String	Identificativo del servizio di ricezione sui quali sono stati ricevuti gli sms
fromDate	No (Obbligatorio valorizzare almeno uno tra il campo from, simIdRef, fromDate e toDate)	String	Data dalla quale gli sms sono stati ricevuti in formato yyyy-MM-ddTHH:mm:ssZ Il carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
toDate	No (Obbligatorio valorizzare almeno uno tra il campo from, simIdRef, fromDate e toDate)	String	Data fino alla quale gli sms sono stati ricevuti in formato yyyy-MM-ddTHH:mm:ssZ Il carattere Z indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)
offset	No	Integer	Posizione del primo risultato che verrà restituito. Esempio: Se la ricerca trova 100 sms, il campo offset viene valorizzato a 50 ed il campo limit a 10 verranno restituiti gli sms da 51 a 60. Default : 0
limit	No	Integer	Numero di risultati che verranno restituiti. Default : 20

Risposta

HTTP Status Code

Codice	Descrizione
200	ok
400	Parametri non validi I possibili `errorMsg` sono: `NO_PARAMS` - Parametro mancante `BAD_DATE` - Formato data errato
401	Credenziali non valide
405	Metodo HTTP non consentito
500	Errore generico

La chiamata ritorna una lista di sms ricevuti.

Proprietà	Descrizione
smsList	Lista degli sms ricevuti Ogni sms è descritto dalla proprietà: from - numero di cellulare di chi ha inviato il messaggio text - testo del messaggio receiveDate - data ricezione del messaggio nel formato yyyy-MM-ddTHH:mm:ssZ simId - identificativo del servizio di ricezione sul quale è stato ricevuto l'sms
metadata	Metadata utili per la paginazioni Per maggiori dettagli sul funzionamento della paginazione visita la pagina dedicata

Proprietà

Descrizione

smsList

Lista degli sms ricevuti

Ogni sms è descritto dalla proprietà:

from - numero di cellulare di chi ha inviato il messaggio

text - testo del messaggio

receiveDate - data ricezione del messaggio nel formato yyyy-MM-ddTHH:mm:ssZ

simId - identificativo del servizio di ricezione sul quale è stato ricevuto l'sms

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.amm.cloud/sms/v2/received/search?fromDate=2011-01-01T00:00:00%2B0200

HttpResponse sms_received_search_response = Unirest.get("https://api.amm.cloud/sms/v2/received/search")
        .basicAuth(SMS_AUTH_KEY, SMS_SECRET_KEY)
        .queryString("fromDate", "2016-01-01T00:00:00+0100")
        .queryString("toDate", "2017-01-01T00:00:00+0100")
        .asJson();

Unirest\Request::auth(SMS_AUTH_KEY, SMS_SECRET_KEY);

$headers = array(
  'Accept' => 'application/json'
);

$param = array(
  'fromDate' => urlencode('2016-01-01T00:00:00+0100'),
  'toDate' => urlencode('2017-01-01T00:00:00+0100')
);

$response = Unirest\Request::get('https://api.amm.cloud/sms/v2/received/search', $headers, $param);

response = unirest.get(
    "https://api.amm.cloud/sms/v2/received/search",
    headers={
        "Accept": "application/json"
        },
    auth=(SMS_AUTH_KEY, SMS_SECRET_KEY),
    params={
        "fromDate": urllib.quote("2016-01-01T00:00:00+0100"),
        "toDate": urllib.quote("2017-01-01T00:00:00+0100")
        }
    )

  String queryString = "?";
  queryString = queryString + "&from=" + HttpUtility.UrlEncode(tbSmsRecvSearchFrom.Text);
  queryString = queryString + "&simRefId=" + HttpUtility.UrlEncode(tbSmsRecvSearchSimRefId.Text);
  queryString = queryString + "&fromDate=" + HttpUtility.UrlEncode(tbSmsRecvSearchFromDate.Text);
  queryString = queryString + "&toDate=" + HttpUtility.UrlEncode(tbSmsRecvSearchToDate.Text);
  queryString = queryString + "&offset=" + HttpUtility.UrlEncode(tbSmsRecvSearchOffset.Text);
  queryString = queryString + "&limit=" + HttpUtility.UrlEncode(tbSmsRecvSearchLimit.Text);
  HttpResponse jsonResponse = Unirest.get(tbSmsRecvSearchUrl.Text + queryString)
      .header("accept", tbSmsRecvSearchAccept.Text)
      .basicAuth(tbAuth_key.Text, tbAuth_secret.Text)
      .asString();

{
   "metadata":{
      "count":2,
      "offset":0,
      "limit":20
   },
   "smsList":[
      {
         "from":"+393450000000",
         "text":"Test sms 1",
         "receiveDate":"2011-04-21T13:23:13+0200"
      },
      {
         "from":"+393480000000",
         "text":"Test sms 1",
         "receiveDate":"2011-01-18T11:42:51+0100"
      }
   ]
}

Lista servizi di ricezione

Ritorna l'elenco dei servizi di ricezione acquistati.

URI

GET https://api.amm.cloud/sms/v2/received/sim/list

Richiesta

Parametro	Obbligatorio	Tipo	Descrizione
Nessun parametro richiesto

Risposta

HTTP Status Code

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

La chiamata ritorna una lista di servizi acquistati. Ogni servizio è descritto dalle seguenti proprietà

Proprietà	Descrizione
id	Identificativo del sercizio di ricezione (Può essere usato nella funzione di ricerca per filtrare gli sms)
sim	Numero sul quale è attivo il servizio di ricezione
key	Se il servizio di ricezione è condiviso il campo key contiene la chiave configurata
expirationDate	Data di scadenza del servizio

Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.amm.cloud/sms/v2/received/sim/list

HttpResponse simlist_response = Unirest.get("https://api.amm.cloud/sms/v2/received/sim/list")
        .basicAuth(SMS_AUTH_KEY, SMS_SECRET_KEY)
        .asJson();

Unirest\Request::auth(SMS_AUTH_KEY, SMS_SECRET_KEY);

$headers = array(
  'Accept' => 'application/json'
);

$response = Unirest\Request::get('https://api.amm.cloud/sms/v2/received/sim/list', $headers);

response = unirest.get(
    "https://api.amm.cloud/sms/v2/received/sim/list",
    headers={
        "Accept": "application/json"
        },
    auth=(SMS_AUTH_KEY, SMS_SECRET_KEY)
    )

  HttpResponse jsonResponse = Unirest.get(tbSimListUrl.Text)
      .header("accept", tbSimListAccept.Text)
      .basicAuth(tbAuth_key.Text, tbAuth_secret.Text)
      .asString();

[
      {
         "id":"265",
         "sim":"393390000000",
         "key":"test",
         "receiveDate":"2011-04-21T13:23:13+0200"
      }
]