@webitel/api-services
    Preparing search index...

    Interface WebitelImApiGatewayV1KeyboardButton

    Defines a single interactive element within the keyboard. Each button must have a unique identifier and a specific action type.

    interface WebitelImApiGatewayV1KeyboardButton {
        callback?: WebitelImApiGatewayV1KeyboardButtonCallback;
        id?: string;
        label?: string;
        metadata?: WebitelImApiGatewayV1KeyboardButtonMetadata;
        request?: WebitelImApiGatewayV1KeyboardButtonRequest;
        url?: WebitelImApiGatewayV1KeyboardButtonURL;
    }
    Index

    Properties

    callback? id? label? metadata? request? url?

    Properties

    callback?: WebitelImApiGatewayV1KeyboardButtonCallback

    Triggers a backend event (callback) with associated metadata.

    id?: string

    Unique idempotent identifier for the button. Used by the frontend to track state and prevent duplicate interactions.

    label?: string

    The human-readable label displayed on the button.

    metadata?: WebitelImApiGatewayV1KeyboardButtonMetadata

    Extensible metadata for UI/UX styling (e.g., "color", "theme", "size"). Usage: Allows for future-proofing without breaking schema changes.

    request?: WebitelImApiGatewayV1KeyboardButtonRequest

    Requests sensitive information from the client (e.g., location or contact).

    url?: WebitelImApiGatewayV1KeyboardButtonURL

    Directs the user to an external web resource.

    Settings

    Member Visibility

    On This Page

    Properties