Webhook výsledku odesílání

Když odešlete zprávu přes JSON API v2, SmsManager vám o výsledku dá vědět webhookem sentMessage. Při každé změně stavu odchozí zprávy pošle HTTP POST na vaši callback URL — obvykle obdržíte počáteční událost sent nebo sending krátce po API volání a následně finální stav doručení, například delivered nebo undelivered. Cíl nastavíte buď pro každou zprávu (polem callback), nebo na úrovni účtu výchozí callback URL.

Webhook payloady jsou vždy pole. I doručení jediné události je zabaleno v [...] a SmsManager může více událostí sloučit do jednoho POST. Zajistěte, aby váš handler procházel každou položku pole, a vždy vracejte HTTP 200 jako potvrzení přijetí.

Reference polí

string

Jedinečný identifikátor původního API požadavku, který tuto zprávu odeslal.Příklad: "bc36f3d1-d284-463a-921b-a3560c154649"

string

Jedinečný identifikátor této zprávy. Když byla zpráva odeslána přes POST /messages, toto ID má tvar <base_id>-<index_příjemce> (např. e27ff0ac-87b5-4e1d-b644-5fc6029e2a11-0).Příklad: "e27ff0ac-87b5-4e1d-b644-5fc6029e2a11"

string

Kanál, který doručil (nebo se pokoušel doručit) zprávu. Jedna z: sms, viber, whatsapp_text, whatsapp_template, rcs.

integer

Unix timestamp události stavu.Příklad: 1700000000

object

Vlastní objekt payload, který jste připojili k původnímu požadavku zprávy, vrácený nezměněn. Použijte to k propojení události s vašimi vlastními záznamy.Příklad: { "campaign_id": "winter-sale" }

string

Vždy "outgoing" pro události sentMessage.

object

Příjemce této události.

Show pole to

string

Telefonní číslo příjemce v mezinárodním formátu.Příklad: "420777123456"

string

Aktuální stav doručení zprávy. Možné hodnoty:

Hodnota	Význam
`sending`	Zpráva je přenášena operatérovi.
`sent`	Zpráva byla přijata operatérem.
`delivered`	Operatér potvrdil doručení na zařízení příjemce.
`seen`	Příjemce zprávu otevřel (pouze Viber / WhatsApp).
`undelivered`	Doručení selhalo po odeslání zprávy.
`rejected`	Zpráva byla odmítnuta před odesláním (např. neplatné číslo, nedostatečný kredit).
`failed`	Došlo k neočekávané chybě.

string

Čitelný popis výsledku, volitelně s předponou číselného kódu v hranatých závorkách. Příklady: "[0] Delivered", "[307] Insufficient credit", "[131042] There was an error related to your payment method", "Unauthorized error".

object

Přítomné, když gateway je sms. Obsahuje detaily fakturace a směrování pro tuto SMS.

Show pole sms

string

Konkrétní použitá nastavení brány (např. high, direct, custom).

string

Jméno nebo číslo odesílatele použité pro tuto zprávu.

integer

Cílová země identifikovaná svým oficiálním MCC (Mobile Country Code).

integer

Cílový operatér identifikovaný svým oficiálním MNC (Mobile Network Code). 0 znamená neznámý nebo obecný operatér.

number

Cena této zprávy v českých korunách (CZK).

number

Cena této zprávy v Eurech (EUR).

integer

Počet odeslaných fakturacích segmentů (dlouhá SMS se dělí do více segmentů).

object

Přítomné, když gateway je viber. Obsahuje stejná podpole jako objekt sms: sender, country, operator, price_czk, price_eur, count.

object

Přítomné, když gateway je whatsapp_template. Obsahuje stejná podpole jako objekt sms.

object

Přítomné, když gateway je whatsapp_text. Obsahuje stejná podpole jako objekt sms.

Příkladový payload

[
  {
    "request_id": "bc36f3d1-d284-463a-921b-a3560c154649",
    "message_id": "e27ff0ac-87b5-4e1d-b644-5fc6029e2a11",
    "gateway": "sms",
    "timestamp": 1700000000,
    "payload": {
      "campaign_id": "winter-sale"
    },
    "type": "outgoing",
    "to": {
      "phone_number": "420777123456"
    },
    "result": "delivered",
    "result_info": "[0] Delivered",
    "sms": {
      "gateway": "high",
      "sender": "MujSender",
      "country": 230,
      "operator": 2,
      "price_czk": 0.85,
      "price_eur": 0.034,
      "count": 1
    }
  }
]

Hledáte příchozí webhooky? Události incomingReplyMessage a incomingMessage jsou popsány v referenci webhooků a v průvodci webhooky.

JSON API v2

HTTP/XML API

REST API

Verify API

WhatsApp Partner API

Referenční tabulky

Reference polí

Příkladový payload

​Reference polí

​Příkladový payload

Reference polí

Příkladový payload