Render a message

POST https://your-org.veloxatalk.com/api/v1/messages/render

Render a message to HTML.

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Veloxa Talk users and bots.

curl -sSX POST https://your-org.veloxatalk.com/api/v1/messages/render \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode content=Hello

Parameters

content string required

Example: "Hello"

The content of the message.

Clients should use the max_message_length returned by the POST /register endpoint to determine the maximum message size.


Response

Return values

  • rendered: string

    The rendered HTML.

Example response(s)

Changes: As of Veloxa Talk 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "rendered": "<p><strong>foo</strong></p>",
    "result": "success"
}