Dev DOC - SMSMobileAPI

SMS-documentatie

SMSmobileAPI-ontwikkelaarsdocumentatie

Bij SMSmobileAPI streven we ernaar om onze API zo compatibel mogelijk te maken met elke architectuur en elk platform.
Of u nu REST, SOAP, cURL of verschillende programmeertalen zoals Python, JavaScript, PHP en meer gebruikt, onze API is ontworpen om naadloos te integreren in uw projecten.

Wij hebben ook kant-en-klare plugins voor e-commerce oplossingen en software. Klik hier om ze te ontdekken.

.
API REST
cURL
Composer
JavaScript JavaScript
Python Python
Node.js Node.js
Robijn Robijn
WSDL
SMS verzenden
Niet-verzonden SMS opnieuw verzenden
LOG SMS verzonden
Ontvangen sms
SMS verwijderen
SMS ontvangen - Webhook
Authenticatie
 

SMS verzenden

Met dit eindpunt kunt u een sms-bericht verzenden vanaf uw mobiele telefoon.

Eindpunt: 

KRIJGEN NA https://api.smsmobileapi.com/sendsms/

Parameters:

Parameter Parameter Beschrijving
apikey
Vereist
Uw unieke API-sleutel.
recipients
Vereist
Het telefoonnummer van de ontvanger.
message
Vereist
Het te verzenden bericht (De berichtlengte is niet beperkt tot 160 tekens; u kunt langere berichten verzenden)
sendwa 1 = het bericht moet via WhatsApp worden verzonden.
sendsms 1 = het bericht moet via een traditionele SMS worden verzonden.
(Als sms versturen is leeg: standaard verzonden, ingesteld op 0 om de SMS te blokkeren)
encrypt_message Ja = Het bericht is gecodeerd wanneer de ontvanger het leest.
De ontvanger moet een unieke sleutel invoeren om het bericht te ontsleutelen.
Meer informatie over berichtversleuteling
schedule_timestamp Geeft de tijd weer vanaf wanneer de sms moet worden verzonden. Moet een UNIX-tijdstempel (GMT 0)

Voorbeeld:

KRIJG https://api.smsmobileapi.com/sendsms?apikey=UW_API_SLEUTEL&recipients=+1234567890&message=HelloWorld
Let op: Als er sprake is van een bezorgfout veroorzaakt door uw provider, wordt standaard geprobeerd hetzelfde sms-bericht maximaal 3 keer binnen een bepaald interval te versturen.



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:

KRIJGEN   NA https://api.smsmobileapi.com/resend/

Parameter: 

Parameter Beschrijving
guid
Vereist
GUID van het bericht dat opnieuw moet worden verzonden.

Voorbeeld:

KRIJG https://api.smsmobileapi.com/resend/?apikey=UW_API_SLEUTEL&guid=GUID_VAN_HET_BERICHT




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:  

KRIJGEN https://api.smsmobileapi.com/log/sent/sms/

Parameter:

Parameter Beschrijving
apikey
Vereist
Uw API-sleutel.
guid_message Kort gezegd de unieke identificatiecode van het bericht die wordt gebruikt voor het sorteren en filteren.
before Haal berichten op die vóór dit specifieke tijdstempel of deze GUID zijn verzonden.
error_api Voer 1 in om alle sms-berichten te tonen waarbij een fout is opgetreden tijdens de API-aanvraag.
error_mobile Voer 1 in om alle sms-berichten te zien waarbij een fout is opgetreden tijdens de mobiele verwerking.
keyword Een trefwoord om berichten te filteren op basis van het telefoonnummer van de ontvanger of de SMS-inhoud.

Voorbeeld:

KRIJG https://api.smsmobileapi.com/log/sent/sms?apikey=UW_API_SLEUTEL  



SMS ontvangen

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

Eindpunt:

KRIJGEN https://api.smsmobileapi.com/getsms/

Parameter: 

Parameter Beschrijving
apikey
Vereist
De API-sleutel die u heeft of zult ontvangen.

Voorbeeld:

KRIJG https://api.smsmobileapi.com/getsms/?apikey=UW_API_SLEUTEL

 

SMS verwijderen

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

Eindpunt:  

KRIJGEN https://api.smsmobileapi.com/deletesms/

Parameter:

Parameter Beschrijving
apikey
Vereist
De API-sleutel die u heeft.
guid_message De unieke ID van het bericht dat u wilt verwijderen.
date_start Als u deze optie alleen gebruikt, worden alle berichten van de opgegeven dag verwijderd.
date_start and date_end Gecombineerd om berichten binnen een bepaalde periode te verwijderen.

Voorbeeld:

KRIJG https://api.smsmobileapi.com/deletesms/?apikey=UW_API_SLEUTEL

Let op: De verwijderde sms-berichten zijn alleen de berichten die zijn opgeslagen in de logs van uw mobiele app-account. Sms-berichten op het mobiele apparaat zelf worden niet verwijderd, omdat wij er geen toegang toe hebben.

 


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:

{
"datum": "2025-01-20",
"uur": "10:15:00",
"tijd_ontvangen": "2025-01-20 10:14:50",
"bericht": "Hallo, dit is een test.",
"nummer": "+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:

<?php
// Lees de binnenkomende payload
$payload = file_get_contents('php://input');
$data = json_decode($payload, true);


// Verwerk de SMS-gegevens
als ($data) {
// Voorbeeld: SMS-gegevens naar een bestand loggen
file_put_contents('sms_log.txt', print_r($data, true), FILE_APPEND);


// Reageer met HTTP 200-status
http_response_code(200);
echo "Webhook succesvol ontvangen.";
} anders {
// Reageer met HTTP 400-status op slechte verzoeken
http_response_code(400);

echo "Ongeldige payload.";
}
?>

De webhook testen

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

Met deze hulpmiddelen kunt u de door het systeem verzonden payload controleren en eventuele problemen met uw webhook-instellingen opsporen.

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.



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 opgenomen in een GET- of POST-verzoek. Dit is een eenvoudige manier om uw API-verzoeken te verifiëren.

2. OAuth2-authenticatie

OAuth2 biedt een veiligere en schaalbare authenticatiemethode.
U moet een client-ID en clientgeheim gebruiken om een toegangstoken te verkrijgen, die vervolgens moet worden opgenomen in uw API-aanvragen met behulp van de Autorisatie koptekst.

De client_id en client_secret vindt u in uw dashboard. U kunt er toegang toe krijgen nadat u de app hebt geïnstalleerd en een account hebt aangemaakt op uw mobiele apparaat.
Download nu de mobiele app of toegang tot uw dashboard.

Een toegangstoken verkrijgen

Om een toegangstoken te verkrijgen, stuurt u een POST-aanvraag naar het tokeneindpunt met uw client-ID en clientgeheim.

curl -X POST https://api.smsmobileapi.com/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=1ab0ex4b4c1ef2c800690d" \
-d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

Het toegangstoken gebruiken:

Zodra u de toegangstoken hebt, voegt u deze toe aan de Autorisatie header van uw API-verzoeken:

curl -X POST https://api.smsmobileapi.com/sendsms \
-H "Autorisatie: Drager abc123xyz456" \
-H "Inhoudstype: toepassing/x-www-formulier-urlengecodeerd" \
-d "ontvangers=+1234567890" \
-d "bericht=Hallo"

Welke methode moet u gebruiken?

- Gebruik API-sleutelauthenticatie voor snelle en eenvoudige integraties.

- Gebruik OAuth2-authenticatie voor verbeterde beveiliging en schaalbaarheid van uw integraties.

Voor meer informatie verwijzen wij u naar de volledige documentatie.


U kunt WhatsApp-berichten alleen via onze API versturen. Klik hier voor meer informatie.

Als u vragen, suggesties of hulp nodig hebt, staat ons team voor u klaar.
Neem gerust contact met ons op via api@smsmobileapi.com

Afhankelijk van de Android-versie die op een mobiele telefoon is geïnstalleerd, kan het besturingssysteem de juiste werking van het automatisch verzenden en ontvangen van sms-berichten belemmeren als de applicatie SmsMobileApi niet op de voorgrond staat.
Dit probleem wordt veroorzaakt door een proces dat op de achtergrond probeert te draaien wanneer de app niet actief is gestart. Vanwege de batterij-optimalisatiemaatregelen van Android, die per versie verschillen, wordt dit achtergrondproces echter mogelijk niet correct gestart. De batterij-optimalisatie van Android is ontworpen om de achtergrondactiviteit van apps te beperken om de batterij te sparen. Dit kan onbedoeld van invloed zijn op apps die achtergrondprocessen nodig hebben om goed te functioneren.

Om dit probleem te verhelpen, kunnen gebruikers de Android-instellingen handmatig configureren, zodat de SmsMobileApi bronnen zonder beperkingen kan gebruiken.
Dit houdt in dat de batterij-optimalisatie-instellingen voor de specifieke app worden aangepast. Android krijgt hiermee in feite de instructie dat de SmsMobileApi op de achtergrond mag draaien en resources mag gebruiken wanneer dat nodig is. Hierdoor zou de applicatie automatisch sms-berichten moeten kunnen verzenden en ontvangen, zelfs wanneer deze niet de actieve applicatie op de voorgrond is. Deze aanpassing zorgt ervoor dat het benodigde achtergrondproces ononderbroken kan werken, waardoor de batterij-optimalisatiefuncties worden omzeild die anders de correcte uitvoering ervan zouden kunnen verhinderen.


Veelgestelde vragen voor ontwikkelaars

Beschrijving van het accordeonvoorbeeld: Om een API-sleutel te genereren, downloadt u onze applicatie op uw mobiele telefoon en maakt u gratis een account aan. Er wordt automatisch een API-sleutel gegenereerd en gekoppeld aan uw mobiele telefoon. U ontvangt ook een e-mail met alle benodigde informatie. Dit proces zorgt ervoor dat u snel en eenvoudig met minimale installatie aan de slag kunt met onze diensten.
Navigeer in uw mobiele applicatie naar het menu INSTELLINGEN of HELP, waar uw API-sleutel altijd zichtbaar is. Zo heeft u altijd eenvoudig toegang tot uw API-sleutel wanneer u deze nodig hebt om onze diensten te integreren of te gebruiken.
Ja, we hebben geen identiteitsbewijs nodig voor het aanmaken van een API-sleutel. De communicatie tussen onze API en uw mobiele telefoon is daarom 100% anoniem. Deze aanpak stelt gebruikers in staat hun privacy te behouden tijdens het gebruik van onze diensten.

Begin vandaag nog met SMSmobileAPI!

Ervaar de vrijheid en flexibiliteit van het beheren van uw sms-diensten onderweg. Download nu onze mobiele app en zet de eerste stap naar naadloze sms-integratie.

Download de app
Verbind mijn mobiel