SMS

  1. Home
  2. Libreria API
  3. SMS
SMS di Alta Qualità con report di consegna, mittente personalizzato e invio in real time

Integra via API il servizio di invio SMS professionali per autenticazione, notifiche, remind, alert verso destinatari singoli o multipli

Tutte le informazioni di cui hai bisogno

Qui trovi qualche consiglio da prendere in considerazione per approcciare a questa API. Se preferisci forniamo esempi di codice, documentazione in OAS3, la possibilità di provare l'API dal vivo con la Swagger UI oppure importare l'intera collezione in Postman. Offriamo inoltre un ambiente di Sandbox dove puoi sperimentare tutte le API gratuitamente.

Utili consigli per iniziare con SMS

Prendi il token nell'apposita sezione prima di cominciare.

Usa lo strumento online o generalo via API. Imposta una data di scadenza e aggiungi una serie di Scopes per limitare le possibli azioni permesse al token.
Approfondisci Oauth Gestisci i tokens
API docs by Redocly

Gateway SMS (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Questo servizio web espone chiamate REST per inviare messaggi di testo direttamente dal nostro gateway.

Prima volta qui? Generare un nuovo token di accesso

Messages

Chiamate per inviare, visualizzare e modificare messaggi SMS

Elenco dei messaggi

Questo metodo consente di visualizzare l'elenco dei messaggi inviati dal proprio account.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects (Messages)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "5 Results",
  • "credit": "91.00299999999986",
  • "error": null
}

Inviare un messaggio sms

Questo metodo consente di inviare un messaggio sms direttamente dal nostro gateway.

Authorizations:
bearerAuth
Request Body schema: application/json
test
boolean

Per impostazione predefinita è falso, se impostato su vero simula un invio

sender
required
string

Il mittente deve essere compreso tra 3 e 11 caratteri se alfanumerico e tra 3 e 14 se numerico.

body
required
string

Testo dell'sms; possiamo inserire nel testo i valori dei parametri 'segnaposto' contenuti nei 'campi' in questo modo: "corpo": "Test invio {{nome}}"

required
string or Array of strings or object

Il numero di telefono del destinatario e l'oggetto 'campi' in cui inserire i parametri che vogliamo inserire nel 'corpo', come questo: {'numero':'+39-34xxxxx987', 'campi':{'nome':'simone', 'cognome':'rossi'}}. Obbligatorio è il prefisso internazionale, che deve essere separato dal resto con '-', come ad esempio: '+39-numero'. Qualsiasi altro formato sarà considerato un cattivo destinatario e inserito tra i non validi.

priority
number <double>

Priorità di invio; l'impostazione predefinita è 1,00, che è la minima; aumentando la priorità si aumenta il costo totale del messaggio, ma supponendo che nella coda ci siano 1000 messaggi con priorità 1,00, inviando un messaggio con priorità 1,01 si salta la coda

object (Options)
transaction
boolean

Per impostazione predefinita, è impostato FALSO. Impostato su TRUE, avvia una transazione memorizzando i dati inviati, ma non inserendo la richiesta nella coda. Le successive chiamate PUT possono essere effettuate sul punto finale '/messages/{id}/' per integrare la chiamata POST iniziale (ad esempio aggiungendo destinatari), finché non viene inviata una PUT con 'transaction' : FALSE. Il campo ID viene restituito dalla prima chiamata POST. A quel punto la transazione (se valida) viene chiusa e i messaggi vengono accodati normalmente.

Responses

Response Schema: application/json
Array of objects (Message_Object)
success
boolean
message
string
credit
string
error
integer

Request samples

Content type
application/json
{
  • "test": false,
  • "sender": "alberto",
  • "body": "test invio",
  • "recipients": "+39-349xxxxx18"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Message Queued",
  • "credit": "90.90849999999988",
  • "success": true,
  • "error": null
}

Ottenere un singolo messaggio

Questo metodo consente di visualizzare il singolo messaggio relativo al parametro passato nel percorso

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5cf7cc139f272546624d3795

Id del messaggio

Responses

Response Schema: application/json
Array of objects (Message_Object)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "1 Result",
  • "credit": "90.97149999999986",
  • "success": true,
  • "error": null
}

Integrazione dei messaggi

Se esiste un messaggio con 'transaction = true', questo metodo consente di integrare la chiamata POST iniziale (aggiungendo ad esempio i destinatari) fino a quando non viene passato un PUT con 'transaction = false'. A quel punto il messaggio viene chiuso e messo nella coda di invio. Con questo metodo si può anche modificare la data di invio del messaggio ('timestamp_send') (se non è già stato inviato o programmato per l'invio).

Authorizations:
bearerAuth
Request Body schema: application/json
required
string or Array of strings or object

Il numero di telefono del destinatario e l'oggetto 'campi' in cui inserire i parametri che vogliamo inserire nel 'corpo', come questo: {'numero':'+39-34xxxxx987', 'campi':{'nome':'simone', 'cognome':'rossi'}}. Obbligatorio è il prefisso internazionale, che deve essere separato dal resto con '-', come ad esempio: '+39-numero'. Qualsiasi altro formato sarà considerato un cattivo destinatario e inserito tra i non validi.

transaction
boolean

Finché non viene impostato a false, la transazione non viene chiusa e il messaggio non viene inserito nella coda di invio.

object

Responses

Response Schema: application/json
object (Message_Object)
success
boolean
message
string
credit
string
error
integer

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Updated",
  • "credit": "90.97149999999986",
  • "success": true,
  • "error": null
}

Eliminare un singolo messaggio

Questo metodo consente di annullare e quindi di non inviare un messaggio (non è consentito per i messaggi già inviati o programmati per l'invio). La cancellazione non comporta il rimborso dei crediti spesi.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5cf7cc139f272546624d3795

Id del messaggio

Responses

Response Schema: application/json
data
Array of strings
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [ ],
  • "message": "5cf7cc139f272546624d3795 Deleted",
  • "success": true,
  • "error": null
}

Ottenere i destinatari di un messaggio

Questo metodo consente di visualizzare i destinatari di un determinato messaggio.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5e5e65429f272510fb6adcc0

Id del messaggio

Responses

Response Schema: application/json
Array of objects (Recipient_Object)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D/recipients/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "1 Result",
  • "credit": 90.20949999999985,
  • "success": true,
  • "error": null
}

Ottenere il destinatario di un messaggio

Questo metodo consente di visualizzare il destinatario specifico di un determinato messaggio.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5e5e65429f272510fb6adcc0

Id del messaggio

number
required
string
Example: +39-34xxxxx018

Numero del destinatario

Responses

Response Schema: application/json
Array of objects (Recipient_Object)
success
boolean
message
string
credit
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D/recipients/%7Bnumber%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "1 Result",
  • "credit": 90.20949999999985,
  • "success": true,
  • "error": null
}
Web Service Revision: 2.0.0