Parametrizace zpráv

Atribut params

Pomocí tohoto atributu můžete ovlivnit obsah zpráv na základě definovaných pravidel.

Zkrácení dlouhých URL (objekt _url)

Vložte do JSON objektu atribut params dle následujícího příkladu

{
    "params": {
      "_url": {
        "domain": "[doména pro zkrácení]",
        "type": "full",
        "get_enhance": false,
        "get_name": "_"
      }
    }
}

Parametr	Popis	Výchozí
domain	Doména, která bude použita pro zkrácení URL adresy.	Systémová doména (je nutné znát tvar domény pro nastavení. Kontaktujte nás pro použití tohoto parametru. Lze využít i vlastní doménu.)
type	Typ zkrácení. Možné hodnoty jsou full (vyžaduje kompletní URL tedy vč. protokolu) nebo all (zkrátí všechny výskyty vč. zápisů "mojedoma.cz").	full
get_enhance	Pokud je code, přidá ke zkrácené URL GET parametr (s názvem dle get_name, viz dále) s obsahem odpovídající zkrácenému alfanumerickému kódu. Pokud hodnotou id je obsahem GET parametru ID zprávy (message_id)	false
get_name	Název GET parametru použitého pro get_enhance.	_
expires_at	Lze nastavit unix timestamp pro moment expirace zkráceného linku. Nedoporučujeme používat delší než 30 dní	7 dní

Příklad 1

{
    "params": {
      "_url": {
        "domain": "zkrdoma.in", //pouze příklad
        "type": "full",
        "get_enhance": "id",
        "get_name": "original_id"
      }
    }
}

Původní text v API požadavku: "Pro pokračování se přihlašte na adrese https://www.example.com/login/"

Text v SMS zprávě: "Pro pokračování se přihlašte na adrese https://zkrdoma.in/3SDF23"

Finální URL po rozkliknutí: https://www.example.com/login/?original_id=0ab5a46f-8f6c-46ac-8ab0-074573d3c8fb

Příklad 2

{
    "params": {
      "_url": {
        "domain": "zkrdoma.in", //pouze příklad
        "type": "full",
        "get_enhance": "code",
        "get_name": "code"
      }
    }
}

Původní text v API požadavku:"Pro pokračování se přihlašte na adrese https://www.example.com/login/"

Text v SMS zprávě: "Pro pokračování se přihlašte na adrese https://zkrdoma.in/3SDF23"

Finální URL po rozkliknutí: https://www.example.com/login/?code=3SDF23