Documentation - v0.29.6
    Preparing search index...

    Interface InputMediaPoll

    A simple poll to be sent

    Note: when using user account, the poll can't be sent to PMs, only to channels/groups, otherwise there will be MEDIA_INVALID error.

    interface InputMediaPoll {
        answers: (InputText | InputPollAnswer | TypePollAnswer)[];
        attachedMedia?: InputMediaLike;
        caption?: InputText;
        closed?: boolean;
        closeDate?: number | Date;
        closePeriod?: number;
        disableRevoting?: boolean;
        hideResultsUntilClose?: boolean;
        multiple?: boolean;
        openAnswers?: boolean;
        public?: boolean;
        question: InputText;
        shuffleAnswers?: boolean;
        type: "poll";
    }

    Hierarchy (View Summary)

    Index

    Properties

    answers attachedMedia? caption? closed? closeDate? closePeriod? disableRevoting? hideResultsUntilClose? multiple? openAnswers? public? question shuffleAnswers? type

    Properties

    answers: (InputText | InputPollAnswer | TypePollAnswer)[]

    Answers of the poll.

    You can either provide a string, or a TL object representing an answer. Strings will be transformed to TL objects, with a single=byte incrementing option value.

    attachedMedia?: InputMediaLike

    Media attached to the poll

    caption?: InputText

    Caption of the media

    closed?: boolean

    Whether this is poll is closed (i.e. nobody can vote anymore)

    closeDate?: number | Date

    Point in time when the poll will be automatically closed.

    Must be at least 5 and no more than 600 seconds in the future, can't be used together with closePeriod.

    When number is used, UNIX time in ms is expected

    closePeriod?: number

    Amount of time in seconds the poll will be active after creation (5-600).

    Can't be used together with closeDate.

    disableRevoting?: boolean

    Whether retracting the votes should be disabled in the poll

    hideResultsUntilClose?: boolean

    Whether the results of the poll should be hidden until the end of the poll

    multiple?: boolean

    Whether users can select multiple answers as an answer

    openAnswers?: boolean

    Whether participants can suggest new options to the poll

    public?: boolean

    Whether this is a public poll (i.e. users who have voted are visible to everyone)

    question: InputText

    Question of the poll (1-255 chars for users, 1-300 chars for bots)

    shuffleAnswers?: boolean

    Whether answers to the poll should be shuffled before showing to the user

    type: "poll"

    Settings

    Member Visibility

    On This Page

    Properties