Responses

• default
  Hide response attributes Show response attributes object

  • ok boolean Required

    Default value is false.

  • error_code integer Required
  • description string Required
  • parameters object

    Contains information about why a request was unsuccessful.

    Hide parameters attributes Show parameters attributes object

    • migrate_to_chat_id integer

      Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

    • retry_after integer

      Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated

• 200
  Hide response attributes Show response attributes object

  • ok boolean Required

    Default value is true.

  • result object Required

    This object represents a sticker set.

    Hide result attributes Show result attributes object

    • name string Required

      Sticker set name

    • title string Required

      Sticker set title

    • is_animated boolean Required

      True, if the sticker set contains animated stickers

    • contains_masks boolean Required

      True, if the sticker set contains masks

    • stickers array[object] Required

      This object represents a sticker.

      Hide stickers attributes Show stickers attributes array[object]

      • file_id string Required

        Identifier for this file, which can be used to download or reuse the file

      • file_unique_id string Required

        Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

      • width integer Required

        Sticker width

      • height integer Required

        Sticker height

      • is_animated boolean Required

        True, if the sticker is animated

      • thumb object

        This object represents one size of a photo or a file / sticker thumbnail.

        Hide thumb attributes Show thumb attributes object

        • file_id string Required

          Identifier for this file, which can be used to download or reuse the file

        • file_unique_id string Required

          Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

        • width integer Required

          Photo width

        • height integer Required

          Photo height

        • file_size integer

          Optional. File size

      • emoji string

        Optional. Emoji associated with the sticker

      • set_name string

        Optional. Name of the sticker set to which the sticker belongs

      • mask_position object

        This object describes the position on faces where a mask should be placed by default.

        Hide mask_position attributes Show mask_position attributes object

        • point string Required

          The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

          Values are forehead, eyes, mouth, or chin.

        • x_shift number Required

          Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.

        • y_shift number Required

          Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.

        • scale number Required

          Mask scaling coefficient. For example, 2.0 means double size.

      • file_size integer

        Optional. File size

    • thumb object

      This object represents one size of a photo or a file / sticker thumbnail.

      Hide thumb attributes Show thumb attributes object

      • file_id string Required

        Identifier for this file, which can be used to download or reuse the file

      • file_unique_id string Required

        Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

      • width integer Required

        Photo width

      • height integer Required

        Photo height

      • file_size integer

        Optional. File size