Core Module

Welcome Module

Create engaging, personalized welcome messages for new members joining your Telegram groups. Support for rich media, inline buttons, and dynamic variables.

Starter Planv2.5.0Most Popular

Features

Personalized Messages

Use variables like {username}, {group_name}, and more for dynamic content

Rich Media Support

Include images, videos, GIFs, and stickers in your welcome messages

Multiple Languages

Set different welcome messages based on user language preferences

Delay Options

Configure delay before sending welcome message to prevent spam

Button Actions

Add inline keyboard buttons for rules, links, or verification

Conditional Logic

Show different messages based on user properties or time of day

Quick Start

Get the Welcome module up and running in just a few steps:

Enable the Welcome module in your group settings

Configure your welcome message text

Add optional media (image, video, or GIF)

Set up inline buttons if needed

Test with a new member or use the preview function

Configuration Options

Option	Type	Description
`enabled`	boolean	Enable or disable the welcome module
`message`	string	The welcome message text with variable support
`mediaType`	enum	Type of media: none, image, video, gif, sticker
`mediaUrl`	string	URL or file_id for the media attachment
`buttons`	array	Inline keyboard buttons configuration
`deleteAfter`	number	Auto-delete welcome message after X seconds (0 = never)
`showInPrivate`	boolean	Also send welcome message in private chat
`delaySeconds`	number	Delay before sending welcome message

Available Variables

Use these variables in your welcome message to personalize the greeting:

{username}

The user's Telegram username

{first_name}

The user's first name

{last_name}

The user's last name

{full_name}

The user's full name

{user_id}

The user's Telegram ID

{group_name}

The group/channel name

{member_count}

Current member count

{date}

Current date

{time}

Current time

API Examples

Enable Welcome Module

PATCH /api/bot-modules/groups/:groupId/welcome

const response = await fetch(
  'https://api.botlaunch.io/api/bot-modules/groups/{groupId}/welcome',
  {
    method: 'PATCH',
    headers: {
      'Authorization': 'Bearer {your_token}',
      'Content-Type': 'application/json',
      'x-organization-id': '{org_id}'
    },
    body: JSON.stringify({
      enabled: true,
      config: {
        message: "Welcome {first_name} to {group_name}!\n\nPlease read the rules before posting.",
        mediaType: "image",
        mediaUrl: "https://example.com/welcome-banner.jpg",
        buttons: [
          {
            text: "Read Rules",
            url: "https://example.com/rules"
          },
          {
            text: "I Agree",
            callback_data: "accept_rules"
          }
        ],
        deleteAfter: 300,
        delaySeconds: 2
      }
    })
  }
);

Example Response

Response JSON

{
  "id": "mod_abc123",
  "groupId": "grp_xyz789",
  "moduleType": "welcome",
  "enabled": true,
  "config": {
    "message": "Welcome {first_name} to {group_name}!",
    "mediaType": "image",
    "mediaUrl": "https://example.com/welcome-banner.jpg",
    "buttons": [
      { "text": "Read Rules", "url": "https://example.com/rules" }
    ],
    "deleteAfter": 300,
    "delaySeconds": 2
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z"
}

Best Practices

Keep it concise

Welcome messages should be brief and to the point. Include essential information only.

Use personalization

Always include at least the user's name to make the welcome feel personal.

Add a call-to-action

Guide new members on what to do next - read rules, introduce themselves, etc.

Consider auto-delete

For active groups, auto-delete welcome messages after a few minutes to reduce clutter.

Test thoroughly

Use the preview function to test how your welcome message looks before going live.

Modules Overview

Anti-Spam Module