API

Ontvang bericht

Haal details op voor zowel inkomende als uitgaande berichten en verifieer authenticatiecodes die naar uw klanten zijn verzonden. Krijg toegang tot een lijst met alle berichten of zoek informatie over een specifiek bericht met behulp van de unieke bericht-ID die is opgegeven toen het werd gemaakt of ontvangen.

Gebruiksvoorbeelden

Lijst met berichten ophalen
Haal een specifiek bericht op
Controleer code

De gebruikersverificatie is succesvol geweest als de header X-Total-Count de waarde 1 heeft of als de gegevensobjectlijst als antwoord niet leeg is.

Volledige aanvraagparameters

Er zijn geen aanvraagparameters vereist.

Volledige responsparameters

Reactieparameters

Het antwoord bevat alle parameters van de aanvraag, samen met de aanvullende parameters die hieronder worden vermeld.

Naam	Vriendelijk	Beschrijving
data	`object`	Bevat de onderstaande details van het bericht dat wordt verzonden.

GegevensObject

Naam	Vriendelijk	Beschrijving
account_id	`string`	Unieke identificatie van uw account.
id	`string`	Unieke identificatie van uw bericht.
from	`string`	Weergavenaam waarvan je bericht wordt verzonden. Je kunt de beschikbare namen bekijken of een nieuwe aanmaken op de afzenderspagina.Ga naar de afzenderspagina.
to	`string[]`	Het (de) mobiele telefoonnummer(s) van de ontvanger in internationaal formaat.
status	`string`	Initiële status van uw bericht. Mogelijke waarden: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Het communicatiekanaal stuurt uw boodschap door. Mogelijke waarden: `SMS` En `WHATSAPP` Standaard: `SMS`
text	`string`	Uw sms-bericht dat naar de ontvanger(s) wordt verzonden.
template_id	`string`	Unieke identificatie van je verzonden sjabloon. Je kunt de beschikbare sjablonen bekijken of een nieuwe aanmaken via de sjablonenpagina van je account.Ga naar de sjablonenpagina.
parameters	`string[]`	Deze waarden worden gebruikt om de tijdelijke aanduidingen in uw berichtsjabloon te vervangen, waardoor u het bericht voor elke ontvanger kunt aanpassen. Standaard: Leeg
segment_count	`integer`	Het aantal segmenten waaruit uw bericht bestond.
encoding	`string`	Codering van uw bericht. Mogelijke waarden: `STANDARD` En `UNICODE`
country	`string`	Bestemmingsland van uw berichtontvanger.
direction	`string`	Geeft aan of het bericht door uw systeem wordt ontvangen of vanaf uw systeem naar de ontvanger wordt verzonden. Mogelijke waarden: `OUTBOUND`, `INBOUND`
type	`string`	Determines the structure of the message content. Mogelijke waarden: `TEXT`, `TEMPLATE`
create_date	`string`	Tijdstip waarop het bericht is geïnitieerd
update_date	`string`	Laatste statusupdatedatum van uw bericht.
code	`string`	User provided Code, 4-6 digit
expired	`boolean`	Indicates whether the code is expired. Mogelijke waarden: `TRUE`, `FALSE` Standaard: `FALSE`

Lijst met berichten ophalen

GET

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

Haal een specifiek bericht op

GET

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

Controleer code

GET

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

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

Reactievoorbeeld

'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"
        }
    ]
}