POST | Sõnumite edastamise aruannete saamine kampaaniast

Edastamise aruannete saamine toimub „pakkidena“. Sellisel kujul saab aruanded kätte ainult üks kord iga sõnumi kohta. Kui on vajadus korrata aruannete saamist, siis oleks vajalik kasutada sõnumite identifikaatorite saamise meetodit ja küsida edastamise aruannet iga identifikaatori kohta.

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

URL

https://api.quantumtec.eu/v1/sms/report/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 Kohustuslik Postituse ID.
Limit integer Ei ole kohustuslik Piirab sõnumite edastamise aruannete saamise hulka. Kui parameeter ei ole määratud siis vaikimisi on 50 tk. Maksimaalne on 500 tk.

Vastuseks päringule saadetakse andmekogum JSON formaadis.

Vastuse parameetrid

Parameeter Kirjeldus
bulkId SMS kampaania identifikaator
status

Kampaania staatus:

  1. Uus
  2. Modereerimisel
  3. Modereerimine läbiviidud
  4. Valmistamisel
  5. Valmistatud
  6. Rakendamise käigus
  7. Saatmisel
  8. Peatatud
  9. Saadetud
  10. Peatatud
  11. Tagasi lükatud
  12. Lõpetatud
deliveryResults Andmete kogum, mis koosneb edastamise aruannetest iga sõnumi kohta
deliveryResults(messageID) Sõnumi ID
deliveryResults(partId) Sõnumi osade ID-d, kui sõnum koosneb mitmetest lühisõnumitest siis ID-d on mitu.
deliveryResults(state)

Sõnumi saatmise staatus:

  1. Kohale toimetatud
  2. Aegunud
  3. Kustutatud
  4. Ei ole kohale jõudnud
  5. Vastu võetud
  6. Teadmata
  7. Tagasi lükatud
deliveryResults(delivered) Sõnumite edastamise aruande saamise aeg (UTC).
deliveryResults(errorCode) Vea kood (Toetavad mitte kõik mobiilsideoperaatorid)

Päringu näidis