跳到主要内容

Pin message in chatroom

POST 

/bv/chatroom/v1/chatrooms/messages:pin

Pins a specific message within the chatroom. Authorization requires the chatroom token with the admin role in the header.

Request

Header Parameters

    authorization string

    This API should be invoked with the chatroom token.

Body

required
    pinned_message objectrequired

    Required.

    message objectrequired

    Required. The message to pinned.

    id stringrequired

    Required. The uuid of the message to pinned.

    text stringrequired

    Required. The text of the message to pinned.

    sender objectrequired

    Required. The user who sends the message.

    id stringrequired

    Required. The uuid of the user who sends the message.

    device_id stringrequired

    Required. The device id of the user who sends the message.

    custom_name stringrequired

    Required. The custom name of the user who sends the message.

    action_taker objectrequired

    Required. The user who pinned the message.

    custom_name stringrequired

    Required. The custom name of the user.

Responses

A successful response.

Schema

    object

Loading...