Skip to content

RCS channel properties

There are RCS channel-specific properties that can be used when making calls to the Conversation API. These properties can be listed under channel_properties in the message request.

For example, below is the code for adding the channel specific property RCS_WEBVIEW_MODE on the RCS channel:

{
  "app_id": "{{APP_ID}}",
  "recipient": {
    "identified_by": {
      "channel_identities": [
        {
          "channel": "RCS",
          "identity": "{{RCS_IDENTITY}}"
        }
      ]
    }
  },
  "message": {
    "choice_message": {
      "text_message": {
        "text": "What do you want to do?"
      },
      "choices": [
        {
          "url_message": {
            "title": "Open sinch.com",
            "url": "https://www.sinch.com"
          }
        }
      ]
    }
  },
  "channel_properties": {
    "RCS_WEBVIEW_MODE": "TALL",
    "RCS_CARD_ORIENTATION": "HORIZONTAL",
    "RCS_CARD_THUMBNAIL_IMAGE_ALIGNMENT": "LEFT"
  }
}

The relevant RCS channel properties are detailed in the table below:

Property nameProperty value
RCS_WEBVIEW_MODEThe size of a webview to open when sending an OpenUrl action. Setting this option indicates that a webview should be used. When this property is not provided, the link will be opened in the user's default browser. Possible options are FULL, HALF, and TALL. This property applies to every URL choice that doesn't set its own open_mode; a choice-level open_mode takes precedence. See Webview mode per URL choice.
RCS_CARD_ORIENTATIONDefines the orientation of a standalone rich card for RCS messages. Possible values are HORIZONTAL and VERTICAL. Default: VERTICAL.
RCS_CARD_THUMBNAIL_IMAGE_ALIGNMENTDefines the image preview alignment in a standalone rich card for RCS messages. This property is only relevant when using horizontal rich cards (when RCS_CARD_ORIENTATION is set to HORIZONTAL). Possible values are LEFT and RIGHT. Default: LEFT.