Ga naar inhoud
Rayo SMSRayo SMS Documentatie

API-overzicht en API-sleutels beheren

Integreer Rayo SMS rechtstreeks in uw ERP, CRM, webshop, boekingsplatform of maatwerkapplicatie met onze snelle en betrouwbare RESTful HTTP API.

API-basis-URL

Section titled “API-basis-URL”

Alle HTTP API-verzoeken moeten via HTTPS worden verzonden naar de volgende basis-URL:

https://api.rayosms.nl/v1

API-sleutels beheren

Section titled “API-sleutels beheren”

U kunt uw API-inloggegevens beheren in de Webapplicatie door te navigeren naar Geavanceerd -> Instellingen -> API-sleutels (/settings/api_keys).

  • Automatische eerste sleutel: Zodra uw account wordt aangemaakt, wordt er automatisch een eerste API-sleutel voor u gegenereerd.
  • Tot 25 API-sleutels per account: Klik op API-sleutel genereren om extra sleutels aan te maken (maximaal 25 sleutels). Het gebruik van afzonderlijke sleutels wordt aanbevolen om productie-, test- en individuele microservices of externe integraties van elkaar te scheiden.
  • Levenscyclusbeheer: U kunt individuele API-sleutels op elk moment Activeren, Deactiveren of Verwijderen zonder dat dit invloed heeft op uw andere actieve sleutels.

Authenticatie

Section titled “Authenticatie”

Elk API-verzoek moet via HTTPS een actieve API-sleutel bevatten in de HTTP-header Authorization:

Authorization: ******
Content-Type: application/json

Overzicht van de belangrijkste endpoints

Section titled “Overzicht van de belangrijkste endpoints”

Hieronder vindt u een overzicht van de primaire Rayo SMS API v1-endpoints. Ga naar de Volledige Rayo SMS API-referentie voor gedetailleerde parameterspecificaties en voorbeeldpayloads.

POST /v1/send_sms — Individuele, bulk- of geplande sms verzenden

Section titled “POST /v1/send_sms — Individuele, bulk- of geplande sms verzenden”

Verzendt een sms-bericht naar een of meer mobiele nummers en/of Contactgroepen.

  • Ontvangers & groepen: Geef een array van mobiele nummers, groeps-ID’s of beide door (met automatische ontdubbeling en onderdrukking van contacten die zijn gemarkeerd als Ongeldig).
  • Plannen (scheduledAt): Plan het bericht optioneel in voor toekomstige bezorging door een ISO-8601-tijdstempel mee te sturen.
  • Idempotentie & tracking (clientRequestId): Geef uw eigen unieke referentie-ID mee om statuscontroles en webhook-callbacks aan elkaar te koppelen.
  • Webhook-callbacks: Schakel callbacks voor afleverstatussen per verzoek in.
  • Gratis sandbox-testen (simulateSendFlag): Stel simulateSendFlag: true in om uw request-payload en integratie van begin tot eind te valideren tegen 0 credits en zonder daadwerkelijke sms-berichten naar telefoons te sturen.

GET /v1/balance_in_credits — Creditsaldo controleren

Section titled “GET /v1/balance_in_credits — Creditsaldo controleren”

Retourneert het huidige beschikbare sms-creditsaldo van uw account als een geheel getal (integer), zodat u het verbruik programmatisch kunt monitoren.

GET /v1/check_status — Afleverstatus opvragen

Section titled “GET /v1/check_status — Afleverstatus opvragen”

Haalt de huidige verwerkingsstatus en de afleverrapporten per ontvanger op van een eerder ingediend sms-verzoek door te zoeken op uw eigen clientRequestId of op het smsServerRequestId van Rayo SMS.

DELETE /v1/sms_request_schedules/:id — Een geplande sms annuleren

Section titled “DELETE /v1/sms_request_schedules/:id — Een geplande sms annuleren”

Annuleert en verwijdert een openstaand gepland sms-verzoek (scheduledAt) vóór het geplande uitvoeringstijdstip, waarbij eventueel gereserveerde credits vrijblijven.