跳到主要内容

Create chatroom report

POST 

/bv/chatroom/v1/chatrooms/:id/reports

Generates a specified type of chatroom report.

Request

Path Parameters

    id stringrequired

    Required. The unique id of the chatroom.

Body

required
    type stringrequired

    Possible values: [REPORT_TYPE_CHAT_HISTORIES, REPORT_TYPE_POLL_SUMMARIES, REPORT_TYPE_POLL_VOTES]

    Required. The type of report to create.

    file_name string

    Optional. The report will be saved as the provided file name after downloaded. Default: It'll use the chatroom id as the default file name.

    custom_event_id string

    Deprecated. The customized event identifier will be shown as an Event ID column value in the REPORT_TYPE_CHAT_HISTORIES report if provided. Default: It'll use the chatroom id as the value on the Event ID column.

    time_zone string

    Optional. The related timestamp field will shown in the specified time zone if provided. The name is taken to be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York". Default: UTC.

Responses

A successful response.

Schema
    id string
Loading...