SMS-documentatie

SMS verzenden

Eindpunt: 

Parameters:

Voorbeeld:

Een niet-verzonden sms opnieuw verzenden

Dit API-eindpunt wordt gebruikt om een niet-verzonden sms opnieuw te verzenden (alleen als het bericht een foutstatus heeft).

Eindpunt:

Parameter: 

Voorbeeld: 

Logboek van SMS verzonden via de API

Dit API-eindpunt wordt gebruikt om het logboek op te halen van SMS-berichten die via de API zijn verzonden.

Eindpunt: 

Parameter:

Voorbeeld:

Lijst met verzonden sms-berichten vanaf mobiel

Dit API-eindpunt wordt gebruikt om sms-berichten weer te geven die vanaf uw mobiele apparaat zijn verzonden en gesynchroniseerd met uw SMSMobileAPI-account.

Belangrijk: Deze functie is beschikbaar vanaf Android-versie 4.1.20.

Belangrijk: Deze functie is niet standaard ingeschakeld in de Android-app.

Privacy: Alle gesynchroniseerde informatie wordt geanonimiseerd, vertrouwelijk en veilig verwerkt.

Geschiedenislimiet: Deze API retourneert altijd gegevens van de laatste 7 dagen alleen.

Opmerking: Als u sms-berichten verzendt via het standaard API-eindpunt https://api.smsmobileapi.com/sendsms/Deze sms-berichten kunnen ook in deze lijst voorkomen omdat ze fysiek vanaf uw mobiele apparaat zijn verzonden.

Eindpunt:

Parameters: 

Geretourneerde velden: 

Voorbeeld: 

Voorbeeld met filters:

Voorbeeld met een vooraf gedefinieerde periode:

SMS ontvangen

Dit API-eindpunt wordt gebruikt om SMS-berichten op te halen die op de smartphone zijn ontvangen. 

Eindpunt:

Parameter: 

Voorbeeld:

Markeer ontvangen SMS-berichten als gelezen

Dit API-eindpunt wordt gebruikt om een ontvangen sms-bericht als gelezen te markeren. Alleen API-status.
Dit verandert de leesstatus op de smartphone niet.  

Eindpunt:

Parameter: 

Voorbeeld:

SMS-alias bijwerken

Dit API-eindpunt wordt gebruikt om de alias van een ontvangen sms-bericht bij te werken met behulp van de GUID.

Opmerking: De alias De parameter kan leeg zijn. In dat geval wordt de alias verwijderd.

Eindpunt:

Parameters: 

Voorbeeld: 

Voorbeeld om de alias te wissen:

SMS verwijderen

Dit API-eindpunt wordt gebruikt om sms-berichten uit het serverlogboek van de SMS Mobile API te verwijderen.

Eindpunt: 

Parameter:

Voorbeeld:

Let op: alleen sms-berichten die in de serverlogboeken zijn opgeslagen, worden verwijderd. Sms-berichten op het apparaat zelf worden niet verwijderd.

Lijst met sms-gesprekken

Dit API-eindpunt wordt gebruikt om sms-gesprekken weer te geven die aan uw account zijn gekoppeld.

Elk gesprek is gegroepeerd op telefoonnummer en bevat de bijbehorende inkomende en uitgaande sms-berichten.

Opmerking: Het uitgangspunt van het gesprek wordt bepaald door de origineConversation parameter:

• receivedGesprekken worden eerst gedetecteerd aan de hand van ontvangen sms-berichten. logsmsreceive
• sentGesprekken worden eerst gedetecteerd aan de hand van verzonden sms-berichten. logsmssent

Opmerking: Als numero Als deze optie niet wordt opgegeven, retourneert de API alleen de meest recente gesprekken. Standaard wordt het laatste gesprek geretourneerd. 20 Gesprekken worden beantwoord.

Opmerking: Voor uitgaande sms-berichten, indien timearea_of_message is beschikbaar (voorbeeld: UTC+02), wordt de weergegeven datum automatisch geconverteerd met behulp van deze waarde. Deze geconverteerde datum wordt ook gebruikt voor sortering.

Opmerking: Als resume=1Alleen de meest recente berichten van elk gesprek worden weergegeven. Gebruik resume_line_how om te bepalen hoeveel recente berichten moeten worden opgenomen.

Eindpunt:

Parameters: 

Details over het gedrag: 

Voorbeeld 1 - Lijst met de meest recente gesprekken uit ontvangen sms-berichten: 

Voorbeeld 2 - Lijst met de meest recente gesprekken van verzonden sms-berichten:

Voorbeeld 3 - Filter één specifiek telefoonnummer:

Voorbeeld 4 - Filteren op datumbereik:

Voorbeeld 5 - Hervatmodus met de laatste 3 berichten per gesprek:

Voorbeeld van een succesvol antwoord: 

{ "success": true, "originConversation": "received", "resume": 0, "resume_line_how": null, "conversations": [ { "phone_number": "+10470000001", "contact_alias": "John Doe", "messages": [ { "direction": "incoming", "message_id": "msg_1001", "date": "2026-03-13 08:45:12", "timestamp_utc": "2026-03-13T08:45:12Z", "message": "Hallo, ik wil graag meer informatie.", "status": "received", "mobile_sid": "device_sid_1" }, { "direction": "outgoing", "message_id": "msg_1002", "date": "2026-03-13 10:46:03", "timestamp_utc": "2026-03-13T08:46:03Z", "message": "Natuurlijk, wat wilt u weten?", "status": "sent", "mobile_sid": "device_sid_2" } ] } ] }

Antwoordvelden:

Foutvoorbeeld:

{ "success": false, "error": "Vereiste parameter ontbreekt: apikey" }

Opmerkingen:

Gateway – Lijst met verbonden mobiele apparaten

Lijst met mobiele telefoons die verbonden zijn met uw SMS-gateway.

Eindpunt:

Parameters:

Voorbeeld:

Gateway – Een mobiel label bijwerken

Het label (nom_reference) van een verbonden mobiel apparaat bijwerken.

Eindpunt:

Parameters:

Voorbeeld:

Belangrijk: Een label is verplicht, maar mag leeg zijn. (label=).

Gateway – Verwijder een verbonden mobiel apparaat

Verwijder een verbonden mobiel apparaat van uw gateway (hiermee worden alle geschiedenisregels voor deze SID verwijderd).

Eindpunt:

Parameters:

Voorbeeld:

Webhook – SMS ontvangen

Dit webhooksysteem stuurt een POST-verzoek naar de geconfigureerde URL wanneer er een sms-bericht wordt ontvangen. Het systeem zorgt voor realtime updates door de sms-gegevens naar de opgegeven webhook-URL te sturen.

Hoe u de webhook in het dashboard configureert

Volg deze stappen om uw webhook-URL in het dashboard in te stellen:

1. Meld u aan bij uw account op de SMS Mobiel API Dashboard.
2. Navigeer naar de Webhook-instellingen sectie.
3. Voer uw webhook-URL in (bijv. https://example.com/webhook-endpoint).
4. Klik op de Webhook opslaan knop. 
5. Nadat u de gegevens hebt opgeslagen, stuurt het systeem sms-gegevens naar de geconfigureerde URL.

Webhook-payload

Wanneer een SMS wordt ontvangen, stuurt het systeem de volgende JSON-payload naar uw webhook-URL:

{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Hallo, dit is een test.", "number": "+123456789", "guid": "abcde12345" }

Payloadvelden:

• datum: Datum waarop het SMS-bericht is toegevoegd (JJJJ-MM-DD).
• uur: Uur waarop het SMS-bericht is toegevoegd (UU:mm:ss).
• tijd_ontvangen: Tijdstip waarop het SMS-bericht is ontvangen.
• bericht: Inhoud van het SMS-bericht. 
• nummer: Telefoonnummer van de afzender.
• gids: Unieke identificatie van het SMS-bericht.

Voorbeeld Webhook-eindpunt

Je server zou klaar moeten zijn om inkomende POST-verzoeken te verwerken. Hieronder staat een voorbeeld van een PHP-script om de webhook-payload te verwerken:

De webhook testen

Om uw webhookconfiguratie te testen, kunt u de volgende hulpmiddelen gebruiken:

• Webhook.site
• RequestBin

Probleemoplossing

• Zorg ervoor dat de webhook-URL correct en openbaar toegankelijk is.
• Controleer of uw server een HTTP 200-statuscode retourneert voor succesvolle verzoeken.
• Controleer de logs van uw server op eventuele fouten bij het verwerken van de payload.

Verrijkte sms

Authenticatie

De SMSMobile API ondersteunt twee authenticatiemethoden: met een eenvoudige API-sleutel of met het OAuth2-protocol met een client-ID en clientgeheim.

1. API-sleutelauthenticatie

 Deze methode vereist een API-sleutel die als parameter kan worden meegestuurd in een GET- of POST-verzoek.

2. OAuth2-authenticatie

OAuth2 biedt een veiligere authenticatiemethode.
Gebruik een client-ID en clientgeheim om een toegangstoken te verkrijgen en voeg dit vervolgens toe aan de Autorisatie koptekst.

De client_id en client_secret zijn beschikbaar in uw dashboard.
Download nu de mobiele app of toegang tot uw dashboard.

Een toegangstoken verkrijgen

Het toegangstoken gebruiken:

Welke methode moet u gebruiken?

- Gebruik API-sleutelauthenticatie voor snelle en eenvoudige integraties.

- Gebruik OAuth2-authenticatie voor verbeterde beveiliging en schaalbaarheid.