Skip to main content

Get dictionary

POST 

/bv/chatroom/v1/dictionaries

Retrieves a specific dictionary using its designated id. Authorization requires either the chatroom token with admin role or the dictionary token.

Request

Header Parameters

    authorization string

    This API should be invoked with the chatroom token or dictionary token.

Body

required
    name stringrequired

    Required. The name of the dictionary to create.

    description string

    Optional. The description of the dictionary to create.

Responses

A successful response.

Schema
    dictionary object
    id string

    Output only. The uuid of the dictionary that is used to filter the incoming message from the viewer.

    name string

    Output only. The name of the dictionary.

    description string

    Output only. The description of the dictionary.

    default boolean

    Output only. Indicates the dictionary is the default dictionary that can not be modified or deleted.

    pattern_count int32

    Output only. The number of patterns in the dictionary.

    created_at date-time

    Output only. Indicates the time that the dictionary created.

    updated_at date-time

    Output only. Indicates the time that the dictionary last updated.

Loading...