Set "typing" status for message editing

POST https://p4lang.zulipchat.com/api/v1/messages/{message_id}/typing

Notify other users whether the current user is editing a message.

Typing notifications for editing messages follow the same protocol as set-typing-status, see that endpoint for details.

Changes: Before Zulip 10.0 (feature level 361), the endpoint was named /message_edit_typing with message_id a required parameter in the request body. Clients are recommended to start using sending these typing notifications starting from this feature level.

New in Zulip 10.0 (feature level 351). Previously, typing notifications were not available when editing messages.

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 typing while editing a message.
request = {
    "op": "start",
}
result = client.call_endpoint(
    f"/messages/{message_id}/typing",
    method="POST",
    request=request,
)
# The user has stopped typing while editing a message.
request = {
    "op": "stop",
}
result = client.call_endpoint(
    f"/messages/{message_id}/typing",
    method="POST",
    request=request,
)
print(result)

curl -sSX POST https://p4lang.zulipchat.com/api/v1/messages/47/typing \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode op=start

Parameters

Response

Example response(s)

Changes: As of Zulip 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": "",
    "result": "success"
}