1.7 KiB

Raw Blame History

Render message

Render a message to HTML.

POST {{ api_url }}/v1/messages/render

Arguments

{generate_api_arguments_table|arguments.json|render-message.md}

Usage examples

curl
Python
JavaScript

curl {{ api_url }}/v1/messages/render \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d "content=**foo**"

```python #!/usr/bin/env python

import zulip

Download ~/zuliprc-dev from your dev server

client = zulip.Client(config_file="~/zuliprc-dev")

Render a message

print(client.render_message({"content": "foo"}))

</div>

<div data-language="javascript" markdown="1">
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
```js
const zulip = require('zulip-js');

// Download zuliprc-dev from your dev server
const config = {
    zuliprc: 'zuliprc-dev',
};

zulip(config).then((client) => {
    // Render a message
    const params = {
        content: '**foo**',
    };

    client.messages.render(params).then(console.log);
});

Response

Return values

rendered: The rendered HTML.

Example response

A typical successful JSON response may look like:

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

A typical JSON response for when the required argument content is not supplied:

{
    'code':'REQUEST_VARIABLE_MISSING',
    'result':'error',
    'msg':"Missing 'content' argument",
    'var_name':'content'
}

{!invalid-api-key-json-response.md!}

1.7 KiB Raw Blame History