Specification RCS object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
sender	Text sender. Needs to be registered first. For registration contact support here.	Yes	-
expiration	Time limit after which alternative channel will be used	No	3600
message	Message object. Cannot be used in tandem with following parameters (File, Card, Carousel) see Message object	No	null
file	File object. Cannot be used in tandem with following parameters (Message, Card, Carousel) see File object	No	null
card	Card object. Cannot be used in tandem with following parameters (Message, File, Carousel) see Card object	No	null
carousel	Carousel object. Cannot be used in tandem with following parameters (Message, File, Card) see Carousel object	No	null

Message object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
text	Text of RCS message	Yes	-
suggestions	Suggestions, see Suggestion	No	[]

Example Message object request:

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

File object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
url	Path to the file	Yes	-
force_refresh	force_refresh set to true forces RBM to fetch new content from the specified URL, even if the URL content is cached, which increases message delivery times for users.	No	false
suggestions	Suggestions, see Suggestion	No	[]

Example File object request:

{
  "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": [
          ...
        ]
      }
    }
  }
}

Example File object

Card object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
title	Title of the card	No	null
description	Description of the card	No	null
alignment	Align card to left or right	No	null
orientation	Orientation of the card, horizontal, or vertical	No	null
media	Media, see Card media object	No	null
suggestions	Suggestions, see Suggestion	No	[]

Card Media object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
url	Path to the media object	Yes	-
force_refresh	force_refresh set to true forces RBM to fetch new content from the specified URL, even if the URL content is cached, which increases message delivery times for users.	No	false
height	Height of media object (Short, Medium, Tall)	No	null

Example Card object request:

{
  "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": [
          ...
        ]
      }  
    }
  }
}

Example Card object

Carousel object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
width	Width of the carousel (small, medium)	No	null
cards	List of carousel cards	No	[]

Carousel Card object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
title	Title of carousel card object	No	null
description	Description of a card	No	null
media	Media, see Card media object	No	null
suggestions	Suggestions, see Suggestion	No	[]

Example Carousel object request:

{
  "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": [
              ...
            ]
          }
        ]
      }
    }
  }
}

Example Carousel object

Example Carousel suggestion object

Suggestions object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	Type of a suggestion button, see Suggestion types	No	reply
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed	No	"Ok"
location	Location to be viewed once suggestion button is pressed, see View Location	Yes, not in tandem with following (calendar, phone_number, url)	-
calendar	Calender app opens to create new event after suggestion button is pressed, see Create calendar event	Yes, not in tandem with following (location, phone_number, url)	-
phone_number	Phone number which gets predialed when suggesion button is pressed, see Dial Number	Yes, not in tandem with following (location, calendar, url)	-
url	After pressing suggestion button phone gets redirected to specified url, see Open url	Yes, not in tandem with following (location, calendar, phone_number)	-

Example Location quick reply object

Suggestion type

VALUE	DESCRIPTION
reply	Quick reply
dial_number	Pre dial number
view_location	Display received location
share_location	Share recipients location
open_url	Open received url
create_calendar_event	Create calendar event

Suggestions View Location object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	view_location
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed	No	"Ok"
location	Location to be viewed once suggestion button is pressed.	No	-

Location object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
latitude	Float value of latitude	Yes along with longitude	null
longitude	Float value of longitude	Yes along with latitude	null
query	String name of location to be looked up as a location	Yes if longitude and latitude not set	null
label	String used to label the location in message	No	null

Example of Location suggestion object request:

{
  "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 object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	create_calendar_event
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed.	No	"Ok"
calendar	Calendar app opens to create new event after suggestion button is pressed.	No	-

Calendar object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
start	DateTime of start of the event	No	null
end	DateTime of the end of event	No	null
title	String title of calendar event	No	null
description	Text description of the event	No	null
timezone	String of a timezone	No	null

Example of Calendar event suggestion object request:

{
  "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 object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	dial_number
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed.	No	"Ok"
phone_number	Phone number which gets predialed when suggesion button is pressed.	No	-

Example of Predialed number suggestion request:

{
  "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 object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	open_url
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed.	No	"Ok"
url	Url that you will be redirected to if you click suggestion button.	No	-

Example of Open url suggestion request:

{
  "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 object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	reply
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed.	No	"Ok"

Example of reply suggestion request:

{
  "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 object

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
type	share_location
text	Text of suggestion button	Yes	-
postback	Content that will get send in reply in case suggestion button is pressed.	No	"Ok"

Example Shared location object request:

{
  "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"
          }
        ]
      }
    }
  }
}