API pieprasījumi izmantojot cURL

Sniegtie piemēri balstās uz pašreizējo API versiju (0.15), taču iepriekšējās versijas ir pietiekoši līdzīgas un izmaiņas komandās nav būtiski atšķirīgas.

cURL --data* parametri automātiski iestata Content-Type galveni uz nepieciešamo application/x-www-form-urlencoded, tādēļ piemēros tas netiek atspoguļots. Ja nepieciešams, to iespējams iestatīt izmantojot -H parametru.

SendOne

Nosūta vienu īsziņu vienā API pieprasījumā.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=SendOne" \
--data-urlencode "Number=37199999999" \
--data-urlencode "Sender=YOURNAME" \
--data-urlencode "Content=Hello there"

Vēlamā atbilde:

{
  "MSSID":"123456789012",
  "CC":"371",
  "Phone":"99999999",
  "Length":"1",
  "Unicode":"0",
  "LongSMS":"0",
  "Invalid":false,
  "Network":"LMTLV",
  "Validity":1440
}

Kļūdas atbilde:

{
  "Error":"InvalidNumber"
}

SendMultiple

Nosūta vairākas īsziņas vienā API pieprasījumā.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=SendMultiple" \
--data-urlencode "Sender=YOURNAME" \
--data-urlencode "Content=[[\"+37112341234\"\,"Lorem ipsum dolor sit amet\"],[\"+37198769876","consectetur adipscing elit.\"]]\"

Vēlamā atbilde:

{
  "37112341234": {
    "MSSID":"123456789012",
    "CC":"371",
    "Phone":"99999999",
    "Content":"Lorem ipsum dolor sit amet",
    "Length":"1",
    "Unicode":"0",
    "LongSMS":"0",
    "Invalid":false,
    "Network":"LMTLV",
    "Validity":1440
  },
  "37198769876": {
    "MSSID":"123456789019",
    "CC":"371",
    "Phone":"98769876",
    "Content":"consectetur adipscing elit.",
    "Length":"1",
    "Unicode":"0",
    "LongSMS":"0",
    "Invalid":false,
    "Network":"TELE2LV",
    "Validity":1440
  },
}

SendBatch

Izveido jaunu, tukšu SMS izsūtni.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=SendBatch" \
--data-urlencode "Sender=YOURNAME" \
--data-urlencode "Content=Hello world"

Vēlamā atbilde:

{
  "BatchID":999888777
}

AddBatchRecipients

Pievieno saņēmēju numurus esošai SMS izsūtnei.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=AddBatchRecipients" \
--data-urlencode "BatchID=999888777" \
--data-urlencode "Recipients=[3712987654321, 37129999999]"

Vēlamā atbilde:

{
  "3712987654321": {
    "MSSID":"123456789012"
  },
  "37129999999": {
    "MSSID":"123456789019"
  },
}

GetSenders

Atgriež sarakstu ar reģistrētajiem sūtītāja identifikatoriem.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=GetSenders"

Vēlamā atbilde:

{
  "Senders":["YourBrand1","YourBrand2"]
}

GetDelivery

Atgriež piegādes statusu vienai vai vairākām īsziņām pēc to identifikatoriem.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=GetDelivery" \
--data-urlencode "MSSID=[999888777666,111222333444]"

Vēlamā atbilde:

{
  "999888777666": "Delivered",
  "111222333444": "Undelivered"
}

Kļūdas atbilde:

{
  "Error":"InvalidMSSID"
}

GetReport

Atgriež visus datus par vienu vai vairākām īsziņām pēc to identifikatoriem.

Pieprasījums:

curl -X POST https://traffic.sales.lv/API:0.15/ \
--data-urlencode "APIKey=YOURAPIKEY" \
--data-urlencode "Command=GetReport" \
--data-urlencode "MSSID=[999888777666,111222333444]"

Vēlamā atbilde:

{
  "999888777666": {
    "MSSID":"999888777666",
    "CC":"371",
    "Phone":"99999999",
    "Content":"Lorem ipsum dolor sit amet",
    "Unicode":"0",
    "LongSMS":"0",
    "Length":"1",
    "Status":"Delivered",
    "SendTime":"2021-12-01 09:42:00",
    "DLRTime":"2021-12-01 09.42.02",
    "Validity":1440
  },
  "111222333444": {
    "MSSID":"111222333444",
    "CC":"371",
    "Phone":"11111111",
    "Content":"Lorem ipsum dolor sit amet",
    "Unicode":"0",
    "LongSMS":"0",
    "Length":"1",
    "Status":"Undelivered",
    "SendTime":"2021-12-03 14:44:30",
    "DLRTime":"2021-12-04 14:45:12",
    "Validity":1440
  }
}

Kļūdas atbilde:

{
  "Error":"InvalidMSSID"
}

Atjaunināts: 14/04/2021