POST | Sõnumite edastamise aruande saamine

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

URL

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

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
messageId string Ei ole kohustuslik Sõnumi ID. Puudumise korral saadetakse kõik vastuvõtmata sõnumite edastamise aruanded.
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
messageID Sõnumi ID
partIds Sõnumi osade ID kui sõnum koosneb mitmetest lühisõnumitest
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
delivered Sõnumite edastamise aruande saamise aeg (UTC).
errorCode Vea kood (Toetavad mitte kõik mobiilsideoperaatorid)

Päringu näidis