跳到主要内容

Change poll status in chatroom

POST 

/bv/chatroom/v1/chatrooms/polls/:id:change

Alters the current status of a poll in the chatroom. Available actions include:

  • ACTION_START: Applicable when the current status is POLL_STATUS_QUEUED.
  • ACTION_CLOSE: Applicable when the current status is POLL_STATUS_ACTIVE.
  • ACTION_ARCHIVE: Applicable when the current status is POLL_STATUS_CLOSED. Authorization requires the chatroom token with the admin role.

Request

Path Parameters

    id stringrequired

    Required.

Header Parameters

    authorization string

    This API should be invoked with the chatroom token.

Body

required
    action stringrequired

    Possible values: [ACTION_START, ACTION_CLOSE, ACTION_ARCHIVE]

    Required.

    action_taker objectrequired

    Required.

    custom_name stringrequired

    Required. The custom name of the user.

Responses

A successful response.

Schema

    object

Loading...