POST | SMS kampaania saatmine

Teostatakse POST päringuga, kõik parameetrid annakse üle query string sisse.

URL

https://api.quantumtec.eu/v1/sms/bulk

Pealkirja parameetrid

Parameeter Tähendus
Content-Type application/json
Accept application/json
X-ApiKey API võti autoriseerimiseks

Päringu parameetrid

Parameetrid saadetakse JSON formaadis.

Parameeter Formaat Rakendamine Kirjeldus
bulkId string Ei ole kohustuslik Postituse ID. Kui mitte märkida siis määratakse automaatselt.
From string Kohustuslik Saatja nimi (number)
Text string Kohustuslik Sõnumi tekst
recipients array Kohustuslik Sõnumite saajate numbrite loend
recipients(to) string Kohustuslik Saaja number
recipients(messageId) string Ei ole kohustuslik Märgitakse kliendi poolt juhul kui tekib vajadus kasutada enda sõnumite ID. Kui mitte märkida siis määratakse automaatselt.
startTime string Ei ole kohustuslik Postituse algusaeg. Märgitakse formaadis "2018-01-01T00:10:20.000Z", ajavöönd peab olema UTC. Kui mitte märkida siis postitus algab koheselt.

Vastuseks päringule saadetakse andmekogum JSON formaadis.

Vastuse parameetrid

Parameeter Kirjeldus
bulkId SMS kampaania identifikaator

Päringu näidis