Set "typing" status

Send an event indicating that the user has started or stopped typing on their client. See the typing notification docs for details on Zulip's typing notifications protocol.

POST https://chat.smyl.es/api/v1/typing

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# The user has started to type in the group PM with Iago and Polonius
request = {
    'op': 'start',
    'to': ['[email protected]', '[email protected]']
}
result = client.set_typing_status(request)
print(result)

# The user has finished typing in the group PM with Iago and Polonius
request = {
    'op': 'stop',
    'to': ['[email protected]', '[email protected]']
}
result = client.set_typing_status(request)
print(result)

More examples and documentation can be found here.

const zulip = require('zulip-js');

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

const typingParams = {
    op: 'start',
    to: ['[email protected]', '[email protected]'],
};

zulip(config).then((client) => {
    // The user has started to type in the group PM with Iago and Polonius
    return client.typing.send(typingParams);
}).then(console.log);

curl -X POST https://chat.smyl.es/api/v1/typing \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d "op=start" \
    -d 'to="[email protected]","[email protected]"'

Arguments

Argument Example Required Description
op "start" Yes

Whether the user has started (start) or stopped (stop) to type. Must be one of: start, stop.

notification_to ["[email protected]","[email protected]"] Yes

The recipients of the message being typed, in the same format used by the send_message API. Typing notifications are only supported for private messages, so this should be a JSON-encoded list of email addresses of the message's recipients.

Response

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}