Mark a voice message as played

POST https://connect.suryojasvi.com/api/v1/messages/{message_id}/voice_played

Record that the user has played the voice message in a message, as a messenger marks a voice message heard. The user's other clients and the message's sender are sent a voice_played event the first time; marking it again changes nothing.

Changes: New in Zulip 13.0 (feature level ZF-ac1a1a).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://connect.suryojasvi.com/api/v1/messages/43/voice_played \
    -u EMAIL_ADDRESS:API_KEY

Parameters

message_id integer required in path

Example: 43

The target message's ID.


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"
}