RCS objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
sender	Textový odesílatel. Musí být nejdříve registrován. Pro registraci kontaktujte podporu zde.	Yes	-
expiration	Časový limit po kterém bude použit alternativní kanál	Ne	`3600`
message	Message objekt. Nemůže být použít současně s následujícími parametry (File, Card, Carousel) viz Message objekt	Ne	`null`
file	File objekt. Nemůže být použít současně s následujícími parametr (Message, Card, Carousel) viz File objekt	Ne	`null`
card	Card objekt. Nemůže být použít současně s následujícími parametr (Message, File, Carousel) viz Card objekt	Ne	`null`
carousel	Carousel objekt. Nemůže být použít současně s následujícími parametr (Message, File, Card) viz Carousel objekt	Ne	`null`

Message objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
text	Text RCS zprávy	Ano	-
suggestions	Pole suggestion tlačítek, viz Suggestion	Ne	`[]`

Příklad Message objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
  "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
         ...
        ]
      }
    }
  }
}

File objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
url	Cesta k souboru	Ano	-
force_refresh	force_refresh nastaveno na `true` způsobí opětoivné vyžádání obsahu ze specifikované URL i za předpokladu ze obsah z URL je v cachei. Může zpozdit doručení zprávy k nekterým uživatelům.	Ne	`false`
suggestions	Pole suggestion tlačítek, viz Suggestion	Ne	`[]`

Příklad požadavku File objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "file": {
        "url": "url_test",
        "force_refresh": false,
        "suggestions": [
          ...
        ]
      }
    }
  }
}

Příklad File objektu

File objekt

Card objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
title	Titulek karty	Ne	`null`
description	Popisek karty	Ne	`null`
alignment	Zarovnání vlevo, nebo vpravo	Ne	`null`
orientation	Orientace karty, horizontální, nebo vertikální	Ne	`null`
media	Media objekt, viz Card media objekt	Ne	`null`
suggestions	Pole suggestion tlačítek, viz Suggestion	Ne	`[]`

Card media objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
url	Cesta k souboru	Ano	-
force_refresh	force_refresh nastaveno na `true` způsobí opětovné vyžádání obsahu ze specifikované URL i za předpokladu ze obsah z URL je v cachei. Může zpozdit doručení zprávy k nekterým uživatelům.	Ne	`false`
height	Výška media objektu (Short, Medium, Tall)	Ne	`null`

Příklad požadavku Card objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "card": {
        "title": "Card title",
        "description": "Card description",
        "media": {
          "url": "PATH_TO_AN_IMAGE"
        },
        "suggestions": [
          ...
        ]
      }  
    }
  }
}

Příklad Card objektu

Card Objekt

Carousel objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
width	Šířka carouselu (small, medium)	Ne	`null`
cards	Seznam carousel karet	Ne	`[]`

Carousel card objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
title	Titulek karty	Ne	`null`
description	Popisek Karty	Ne	`null`
media	Media objekt, see Card media objekt	Ne	`null`
suggestions	Pole suggestion tlačítek, viz Suggestion	Ne	`[]`

Příklad Carousel objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "carousel": {
        "width": "medium",
        "cards": [
          {
            "title": "First",
            "description": "First card",
            "media": {
              "url": "PATH_TO_AN_IMAGE"
            },
            "suggestions": [
              ...
            ]
          },
          {
            "title": "Second",
            "description": "Second card",
            "media": {
              "url": "PATH_TO_AN_IMAGE"
            },
            "suggestions": [
              ...
            ]
          }
        ]
      }
    }
  }
}

Příklad Carousel objektu

Carousel Object

Příklad Carousel suggestion objektu

Carousel suggestion Object

Suggestion objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ suggestion tlačítka, viz Suggestion typy	Ne	`reply`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka	Ne	`"Ok"`
location	Lokace zobrazena při kliku na suggestion tlačítko (Použit pouze při nastaveni `view_location` suggestion typu)	Ano, ne současně s následujícími typy (`calendar`, `phone_number`, `url`)	-
calendar	Událost kalendáře jenž se vytvoří při kliku na suggestion tlačítko (Použit pouze při nastaveni `create_calendar_event` suggestion typu)	Ano, ne současně s následujícími typy (`location`, `phone_number`, `url`)	-
phone_number	Telefonní číslo, které se vytočí při kliku na suggestion tlačítko (Použit pouze při nastaveni `dial_number` suggestion typu)	Ano, ne současně s následujícími typy (`location`, `calendar`, `url`)	-
url	Redirekt na url při kliku na suggestion tlačítko (Použit pouze při nastavení `open_url` suggestion typu)	Ano, ne současně s následujícími typy (`location`, `calendar`, `phone_number`)	-

Suggestion typy

HODNOTA	POPIS
`reply`	Rychlá odpověď
`dial_number`	Před vytočit číslo
`view_location`	Zobraz lokaci
`share_location`	Sdílej mou lokaci
`open_url`	Otevři url
`create_calendar_event`	Vytvoř událost v kalendáři

Suggestions View Location objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	`view_location`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka.	Ne	`"Ok"`
location	Lokace zobrazena při kliku na suggestion tlačítko	Ne	-

Location objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
latitude	Desetinné číslo zeměpisné šířky	Ano společne s zeměpisnou výškou	`null`
longitude	Desetinné číslo zeměpisné výšky	Ano společně s zeměpisnou šířkou	`null`
query	Lokace kterou chtece vyhledat na mapě.	Ano pokud zeměpisná výška a šířka nejsou zadané	`null`
label	Název lokace	Ne	`null`

Příklad doporučené lokace

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
          {
            "type": "view_location",
            "text": "View",
            "location": {
              "query": "Karluv most",
              "latitude": 50.086584,
              "longitude": 14.410763,
              "label": "Karluv most"
            }
          }
        ]
      }
    }
  }
}

Suggestions Create calendar event objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	`create_calendar_event`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka.	Ne	`"Ok"`
calendar	Událost kalendáře jenž se vytvoří při kliku na suggestion tlačítko	Ne	-

Calendar objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
start	DateTime počátku události	Ne	`null`
end	DateTime konce události	Ne	`null`
title	Název události	Ne	`null`
description	Popisek události	Ne	`null`
timezone	Časová zóna	Ne	`null`

Příklad doporučené události:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
          {
            "type": "create_calendar_event",
            "text": "Event",
            "calendar": {
              "start": "2024-01-30T13:57:41+01:00",
              "end": "2024-01-30T13:57:41+01:00",
              "title": "title_text",
              "description": "description",
              "timezone": "Europe"
            }
          }
        ]
      }
    }
  }
}

Suggestions Dial Number objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	`dial_number`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka.	Ne	`"Ok"`
phone_number	Telefonní číslo, které se vytočí při kliku na suggestion tlačítko	Ne	-

Příklad předvytočeného čísla

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
          {
            "type": "dial_number",
            "text": "Reply ok",
            "postback": "Ok",
            "phone_number": "url"
          }
        ]
      }
    }
  }
}

Suggestions Open url objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	`open_url`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka.	Ne	`"Ok"`
url	Redirekt na url při kliku na suggestion tlačítko	Ne	-

Příklad doporučené url

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
          {
            "type": "open_url",
            "text": "Reply ok",
            "postback": "Ok",
            "url": "url"
          }
        ]
      }
    }
  }
}

Suggestions Reply objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	`reply`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka.	Ne	`"Ok"`

Příklad doporučené odpovědi

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
          {
            "type": "reply",
            "text": "Reply ok",
            "postback": "Ok"
          }
        ]
      }
    }
  }
}

Suggestions Share location objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	`share_location`
text	Text suggestion tlačítka	Ano	-
postback	Text odpovědi odeslané při stisknutí suggestion tlačítka.	Ne	`"Ok"`

Příklad sdílení lokace

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "rcs": {
      "sender": "BulkGate",
      "message": {
        "text": "text",
        "suggestions": [
          {
            "type": "share_location",
            "text": "Shared location",
            "postback": "ok"
          }
        ]
      }
    }
  }
}