5.9.4 api display text

Funkce PUT /api/display/text zajišťuje zobrazení zprávy na displeji zařízení.

Funkce je součástí služby Displej API a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Displej – řízení.

Metody:
GET – nastaví zprávu na displeji.
DELETE – odstraní zprávu z displeje.

Metoda GET

Lze použít dva formáty vstupu v JSON:

Zpráva s překlady (message[])
Freetext (text)

Kombinace obou formátů není podporována.

Parametry:

Parametr	Povinný	typ	Popis
uid	ne	řetězec	Identifikátor zprávy pro systém třetí strany. Max. délka: 40 znaků
response	ne	bootlean	Určuje, zda zpráva vyžaduje odpověď. Výchozí: `false`.
timeout	ne	number	Časový limit zobrazení (v sekundách). Výchozí: `3600`. Max. hodnoty: `response=true`: `3600` `response=false`: `1209600`
icon	ne	řetězec	Ikona zprávy. Platné hodnoty: `"none"`, `"operator"`, `"technician"`.

Formát zprávy s překlady, parametry klíče message[]:

Parametr	Povinný	Typ	Popis
`language`	Ano	string	Kód jazyka (ISO 639).
`text`	Ano	string	Text zprávy v daném jazyce.

Formát Freetext:

Parametr	Povinný	Typ	Popis
`text`	Ano	string	Text zprávy. Max. délka: 1024 znaků.

Příklad požadavku

{
    "uid": "user_defined_string",
    "message": [
        {
            "language": "en",
            "text": "Hello, how can I help you?"
        },
        {
            "language": "cs",
            "text": "Dobrý den, jak Vám mohu pomoci?"
        }
    ],
    "response": true,
    "timeout": 3600,
    "icon": "operator"
}

Příklad odpovědi

{
    "success": true,
    "result": {
        "response": "",
        "uid": "user_defined_string"
    }
}

Metoda DELETE

Požadavek neobsahuje žádné parametry.

Příklad odpovědi

DELETE /api/display/text
{
    "success": true,
    "result": {
        "uid": "user_defined_string"
    }
}