Set "typing" status for message editing
POST https://chat.hcics.simtech.uni-stuttgart.de/api/v1/message_edit_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: 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",
"message_id": message_id,
}
result = client.call_endpoint(
"message_edit_typing",
method="POST",
request=request,
)
# The user has stopped typing while editing a message.
request = {
"op": "stop",
"message_id": message_id,
}
result = client.call_endpoint(
"message_edit_typing",
method="POST",
request=request,
)
print(result)
curl -sSX POST https://chat.hcics.simtech.uni-stuttgart.de/api/v1/message_edit_typing \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode op=start \
--data-urlencode message_id=47
Parameters
op string required
Example: "start"
Whether the user has started ("start") or stopped ("stop") editing.
Must be one of: "start", "stop".
message_id integer required
Example: 47
Describes the message id of the message being edited.
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"
}