API

Ottieni Messaggio

Recupera i dettagli dei messaggi sia in entrata che in uscita e verifica i codici di autenticazione inviati ai tuoi clienti. Accedi a un elenco di tutti i messaggi o trova informazioni su un messaggio specifico utilizzando l'ID messaggio univoco fornito al momento della creazione o della ricezione.

Esempi di casi d'uso

Recupera l'elenco dei messaggi
Recupera un messaggio specifico
Verifica codice

La verifica dell'utente ha avuto esito positivo se l'intestazione X-Total-Count ha valore 1 o l'elenco degli oggetti dati in risposta non è vuoto.

Parametri di richiesta completi

Non sono richiesti parametri di richiesta.

Parametri di risposta completi

Parametri di risposta

La risposta include tutti i parametri della richiesta, insieme ai parametri aggiuntivi elencati di seguito.

Nome	Tipo	Descrizione
data	`object`	Contiene i seguenti dettagli del messaggio inviato.

DataObject

Nome	Tipo	Descrizione
account_id	`string`	Identificatore univoco del tuo account.
id	`string`	Identificatore univoco del tuo messaggio.
from	`string`	Nome visualizzato dal quale verrà inviato il tuo messaggio. Puoi controllare i nomi disponibili o crearne uno nuovo nella pagina dei mittenti.Vai alla pagina dei mittenti.
to	`string[]`	I numeri di cellulare del destinatario in formato internazionale.
status	`string`	Stato iniziale del tuo messaggio. Valori possibili: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Il canale di comunicazione invia il tuo messaggio. Valori possibili: `SMS` E `WHATSAPP` Predefinito: `SMS`
text	`string`	Il tuo messaggio di testo da inviare ai destinatari.
template_id	`string`	Identificatore univoco del tuo modello inviato. Puoi controllare i modelli disponibili o crearne uno nuovo dalla pagina dei modelli del tuo account.Vai alla pagina dei modelli.
parameters	`string[]`	Questi valori vengono utilizzati per sostituire i segnaposto nel modello di messaggio, consentendoti di personalizzare il messaggio per ciascun destinatario. Predefinito: Vuoto
segment_count	`integer`	Il numero di segmenti di cui era composto il messaggio.
encoding	`string`	Codifica del tuo messaggio. Valori possibili: `STANDARD` E `UNICODE`
country	`string`	Paese di destinazione del destinatario del messaggio.
direction	`string`	Specifica se il messaggio viene ricevuto dal tuo sistema o inviato dal tuo sistema al destinatario. Valori possibili: `OUTBOUND`, `INBOUND`
type	`string`	Determina la struttura del contenuto del messaggio. Valori possibili: `TEXT`, `TEMPLATE`
create_date	`string`	Ora in cui è stato avviato il messaggio
update_date	`string`	Data dell'ultimo aggiornamento dello stato del tuo messaggio.
code	`string`	Codice fornito dall'utente, 4-6 cifre
expired	`boolean`	Indica se il codice è scaduto. Valori possibili: `TRUE`, `FALSE` Predefinito: `FALSE`

Recupera l'elenco dei messaggi

GET

https://api.topmessage.it/v1/messages

Recupera un messaggio specifico

GET

https://api.topmessage.it/v1/messages/{Id}

Verifica codice

GET

https://api.topmessage.it/v1/messages?to={receipnet_number}&code={code}&expired=false

X-TopMessage-Key: {API_KEY}
Content-Type: application/json

Esempio di risposta

'X-Total-Count': 1

{
    "data": [
        {
            "id": "b63ddae0-48c4-4e81-879c-2170a05051ca",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "19134216816",
            "to": "48727516980",
            "channel": "SMS",
            "status": "DELIVERED",
            "text": "Hi there! Just testing out this cool SMS feature. https://topmessage.com",
            "segment_count": 1,
            "direction": "OUTBOUND",
            "country": "US",
            "type": "TEXT",
            "template": {
                "id": "67d0c347-d946-49ed-958f-3de966278525"
            },
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T08:35:13Z",
            "update_date": "2024-11-25T08:35:14Z"
        }
    ]
}