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.
De gebruikersverificatie is succesvol geweest als de header X-Total-Count de waarde 1 heeft of als de gegevensobjectlijst als antwoord niet leeg is.
Hieronder volgen enkele voorbeelden van use cases voor de TopMessage API:
Toegang tot gedetailleerde informatie over al uw verzonden berichten om de levering te controleren, de prestaties te volgen en uw berichtenstrategie te optimaliseren.
Volledige aanvraagparameters
Er zijn geen aanvraagparameters vereist.Volledige responsparameters
Het antwoord bevat alle parameters van de aanvraag, samen met de aanvullende parameters die hieronder worden vermeld.| Naam | Vriendelijk | Beschrijving |
|---|---|---|
| data | object | Bevat berichtinformatie. |
| Naam | Vriendelijk | Beschrijving |
|---|---|---|
| id | string | Unieke identificatie van uw bericht. |
| account_id | string | Unieke identificatie van uw account. |
| status | string | Initiële status van uw bericht. Mogelijke waarden: PENDING, FAILED, DELIVERED, SEEN |
| from | string | Weergavenaam waarvan je bericht wordt verzonden. Je kunt de beschikbare namen bekijken of een nieuwe aanmaken op de afzenderspagina. |
| to | string[] | Het (de) mobiele telefoonnummer(s) van de ontvanger in internationaal formaat. |
| text | string[] | Uw sms-bericht dat naar de ontvanger(s) wordt verzonden. |
| channel | string | Het communicatiekanaal stuurt uw boodschap door. Mogelijke waarden: SMS En WHATSAPPStandaard: SMS |
| segment_count | integer | Het aantal segmenten waaruit uw bericht bestond. |
| encoding | string | Codering van uw bericht. Mogelijke waarden: STANDARD En UNICODE |
| direction | string | Geeft de stroom van het bericht aan – of het werd verzonden door uw systeem of ontvangen van een gebruiker. Mogelijke waarden: OUTBOUND, INBOUND |
| country | string | Geeft het land van de ontvanger aan voor uitgaande berichten en het land van de afzender voor inkomende berichten. De waarde wordt opgegeven in ISO 3166-1 alpha-2 formaat. |
| type | string | Geeft aan welk type berichtinhoud wordt verzonden of ontvangen. Dit helpt bepalen of het een tekstbericht, sjabloon of mediabericht is (zoals afbeeldingen of video's), inclusief interactieve inhoud voor WhatsApp. |
| schedule | string | Geeft de tijd aan wanneer het bericht verzonden moet worden. De tijd moet in UTC zijn en het ISO-8601-formaat volgen ("2024-12-01T18:00:00Z"). De geplande tijd mag niet meer dan 1 jaar in de toekomst worden ingesteld. Standaard: Nu |
| create_date | string | Tijdstip waarop het bericht is geïnitieerd |
| update_date | string | Laatste statusupdatedatum van uw bericht. |
https://api.topmessage.nl/v1/messagesX-TopMessage-Key: {API_KEY}
Content-Type: application/json'X-Total-Count': 1{
"data": [
{
"id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
"account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
"status": "PENDING",
"from": "TopMessage",
"to": "311511234567",
"text": "Hallo! Ik test deze leuke sms-functie. https://topmessage.nl",
"channel": "SMS",
"segment_count": "1",
"encoding": "STANDARD",
"direction": "OUTBOUND",
"country": "NL",
"type": "text",
"schedule": "2024-11-10T08:11:46Z",
"create_date": "2024-11-10T08:11:46Z",
"update_date": "2024-11-10T08:11:46Z"
},
{
"id": "6fc214dc-4e51-4fce-bc0a-324a1d8a542b",
"account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
"status": "PENDING",
"from": "TopMessage",
"to": "311511234568",
"text": "Gewoon even deze sms-functie testen.",
"channel": "SMS",
"segment_count": "1",
"encoding": "STANDARD",
"direction": "OUTBOUND",
"country": "NL",
"type": "text",
"schedule": "2024-11-10T08:11:46Z",
"create_date": "2024-11-10T08:11:46Z",
"update_date": "2024-11-10T08:11:46Z"
}
]
}