Set "typing" status for message editing

POST https://your-org.veloxatalk.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 Veloxa Talk 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 Veloxa Talk 10.0 (feature level 351). Previously, typing notifications were not available when editing messages.

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/47/typing \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode op=start

Parameters

message_id integer required in path

Example: 47

The target message's ID.


op string required

Example: "start"

Whether the user has started ("start") or stopped ("stop") editing.

Must be one of: "start", "stop".


Response

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": "",
    "result": "success"
}