Open URL with Webview

Use the Open URL with Webview action to open a web page inside the messaging app from an RCS suggestion button. The Open URL with Webview action loads the specified web page inside the messaging app with the rendering engine of your default browser. This allows the user to interact with the web page without leaving the RBM conversation.

If the user's device doesn't support webviews, the web page opens in the user's browser instead.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/rcs/v1/message
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Authentication

Pass a valid access token in the Authorization header.

Request headers

Header	Required	Description
Authorization	Yes	Valid access token for authentication.
Content-Type	Yes	Must be `application/json`.

Request parameters

Field	Type	Description
type	string	Type of message. Example: `text`.
phone_no	string	Recipient’s phone number in E.164 format.
text	string	Message text content.
bot_name	string	Name or identifier of the chatbot sending the message.
suggestions	array	List of interactive suggestion buttons.
suggestions[].type	string	Type of suggestion. Example: `url`.
suggestions[].text	string	Button text shown to user.
suggestions[].url	string	URL to open on tap.
suggestions[].postback	string	Type of action to take on tap. `url` indicates a redirection.
suggestions[].application	string	Application to use for viewing. Use `webview` for in-app view.
suggestions[].web_view_mode	string	Mode of the webview, for example `full`, `half`, or `tall`.

Request body

{
  "type": "text",
  "phone_no": "+91xxxxxxxxx",
  "text": "Open this link",
  "bot_name": "Routemobile",
  "suggestions": [
    {
      "type": "url",
      "text": "Tap me",
      "url": "http://routemobile.com",
      "postback": "url",
      "application": "webview",
      "web_view_mode": "half"
    }
  ]
}

Response

{
  "message": "Message request has been created",
  "id": "a69416c8-685e-11f0-9988-0a58a9fdac02"
}