API je určené pre prípady, keď nechcete SMS správy odosielať ručne cez administráciu. Správa sa odošle automaticky vo chvíli, keď vo Vašom systéme nastane konkrétna udalosť.

Ako to funguje v praxi?

Čo sa posiela do API?

Pri základnom odoslaní stačí API token, telefónne číslo príjemcu a text SMS správy. Voliteľne je možné poslať aj vlastné ID správy alebo odosielateľa.

{
    "token": "vas_api_token",
    "action": "send",
    "sender": "sms-portal",
    "messages": [
      [ "number": "421901234567", "text" => "Vaša objednávka bola prijatá." ]
    ]
}

Čo API vráti späť?

Odpoveď je vo formáte JSON. Váš systém tak vie jednoducho zistiť, či bola požiadavka prijatá alebo prečo neprešla.

{
  "status" => "ok",
  "action" => "send",
  "batch_id" => 123,
  "sender" => "sms-portal",
  "count" => 1,
  "sms_parts" => 1,
  "price_eur" => 0.058,
  "credit_before" => 10,
  "credit_after" => 9.942                
}

Kedy sa API oplatí použiť?

API je vhodné hlavne tam, kde sa rovnaký typ SMS správy opakuje pravidelne. Namiesto ručného odosielania sa celý proces spustí automaticky.

• potvrdenie objednávky v e-shope
• zmena stavu objednávky alebo zásielky
• pripomenutie rezervácie alebo termínu
• notifikácia pre zamestnanca alebo technika
• upozornenie zo skladového alebo interného systému