Functions

approve-chat-join-request

fn (request: ApproveChatJoinRequestRequest): Bool
fn (request: ApproveChatJoinRequestRequest, opts: Map): Bool

approveChatJoinRequest - Approve a chat join request. The bot must be an administrator with can_invite_users right.

Example

::chat ::telegram::chat

::chat/approve-chat-join-request(::chat/ApproveChatJoinRequestRequest({
  chat_id: -1001234567890,
  user_id: 123456789
}))

ban-chat-member

fn (request: BanChatMemberRequest): Bool
fn (request: BanChatMemberRequest, opts: Map): Bool

banChatMember - Ban a user from a group or channel. until_date is a Unix timestamp for a temporary ban (30 seconds to 366 days in the future). Set revoke_messages: true to delete all messages from the user.

Example

::chat ::telegram::chat

::chat/ban-chat-member(::chat/BanChatMemberRequest({
  chat_id: -1001234567890,
  user_id: 123456789,
  revoke_messages: true
}))
fn (request: CreateChatInviteLinkRequest): Map
fn (request: CreateChatInviteLinkRequest, opts: Map): Map

createChatInviteLink - Create an additional invite link. member_limit (1-99999) limits joins. expire_date is a Unix timestamp. Set creates_join_request: true to require admin approval.

Example

::chat ::telegram::chat

invite ::chat/create-chat-invite-link(::chat/CreateChatInviteLinkRequest({
  chat_id: -1001234567890,
  name: "Beta testers",
  member_limit: 25
}))
invite.invite_link

decline-chat-join-request

fn (request: DeclineChatJoinRequestRequest): Bool
fn (request: DeclineChatJoinRequestRequest, opts: Map): Bool

declineChatJoinRequest - Decline a chat join request.

Example

::chat ::telegram::chat

::chat/decline-chat-join-request(::chat/DeclineChatJoinRequestRequest({
  chat_id: -1001234567890,
  user_id: 123456789
}))
fn (request: ExportChatInviteLinkRequest): Str
fn (request: ExportChatInviteLinkRequest, opts: Map): Str

exportChatInviteLink - Generate a new primary invite link. Any previously generated primary link is revoked.

Example

::chat ::telegram::chat

link ::chat/export-chat-invite-link(::chat/ExportChatInviteLinkRequest({
  chat_id: -1001234567890
}))

get-chat

fn (request: GetChatRequest): Map
fn (request: GetChatRequest, opts: Map): Map

getChat - Get information about a chat. Returns the full chat object with title, type, description, and settings.

Example

::chat ::telegram::chat

response ::chat/get-chat(::chat/GetChatRequest({
  chat_id: -1001234567890
}))
response.title  // => "My Group"
response.type   // => "supergroup"

get-chat-administrators

fn (request: GetChatAdministratorsRequest): Vec<Map>
fn (request: GetChatAdministratorsRequest, opts: Map): Vec<Map>

getChatAdministrators - Get a list of administrators in a chat. Returns an array of ChatMember objects.

Example

::chat ::telegram::chat

admins ::chat/get-chat-administrators(::chat/GetChatAdministratorsRequest({
  chat_id: -1001234567890
}))
map(admins, %.user.id)

get-chat-member

fn (request: GetChatMemberRequest): Map
fn (request: GetChatMemberRequest, opts: Map): Map

getChatMember - Get information about a specific member of a chat. Returns their status (creator, administrator, member, restricted, left, kicked).

Example

::chat ::telegram::chat

member ::chat/get-chat-member(::chat/GetChatMemberRequest({
  chat_id: -1001234567890,
  user_id: 123456789
}))
member.status

get-chat-member-count

fn (request: GetChatMemberCountRequest): Int
fn (request: GetChatMemberCountRequest, opts: Map): Int

getChatMemberCount - Get the number of members in a chat.

Example

::chat ::telegram::chat

count ::chat/get-chat-member-count(::chat/GetChatMemberCountRequest({
  chat_id: -1001234567890
}))

leave-chat

fn (request: LeaveChatRequest): Bool
fn (request: LeaveChatRequest, opts: Map): Bool

leaveChat - Leave a group, supergroup, or channel.

Example

::chat ::telegram::chat

::chat/leave-chat(::chat/LeaveChatRequest({
  chat_id: -1001234567890
}))

pin-chat-message

fn (request: PinChatMessageRequest): Bool
fn (request: PinChatMessageRequest, opts: Map): Bool

pinChatMessage - Pin a message in a chat. Set disable_notification: true to silently pin.

Example

::chat ::telegram::chat

::chat/pin-chat-message(::chat/PinChatMessageRequest({
  chat_id: -1001234567890,
  message_id: 42,
  disable_notification: true
}))

promote-chat-member

fn (request: PromoteChatMemberRequest): Bool
fn (request: PromoteChatMemberRequest, opts: Map): Bool

promoteChatMember - Promote or demote a user in a supergroup or channel. Pass the specific admin rights to grant. All rights default to false.

Example

::chat ::telegram::chat

::chat/promote-chat-member(::chat/PromoteChatMemberRequest({
  chat_id: -1001234567890,
  user_id: 123456789,
  can_delete_messages: true,
  can_pin_messages: true
}))

restrict-chat-member

fn (request: RestrictChatMemberRequest): Bool
fn (request: RestrictChatMemberRequest, opts: Map): Bool

restrictChatMember - Restrict a user in a supergroup. permissions is a ChatPermissions object controlling what the user can do (send messages, media, polls, etc.).

Example

::chat ::telegram::chat

::chat/restrict-chat-member(::chat/RestrictChatMemberRequest({
  chat_id: -1001234567890,
  user_id: 123456789,
  permissions: {can_send_messages: false},
  until_date: 1798761600
}))
fn (request: RevokeChatInviteLinkRequest): Map
fn (request: RevokeChatInviteLinkRequest, opts: Map): Map

revokeChatInviteLink - Revoke an invite link created by the bot. The link will no longer work.

Example

::chat ::telegram::chat

::chat/revoke-chat-invite-link(::chat/RevokeChatInviteLinkRequest({
  chat_id: -1001234567890,
  invite_link: "https://t.me/+AbCdEf123456"
}))

set-chat-description

fn (request: SetChatDescriptionRequest): Bool
fn (request: SetChatDescriptionRequest, opts: Map): Bool

setChatDescription - Change the description of a group, supergroup, or channel. Pass empty/null to remove the description.

Example

::chat ::telegram::chat

::chat/set-chat-description(::chat/SetChatDescriptionRequest({
  chat_id: -1001234567890,
  description: "Release notes and status updates."
}))

set-chat-permissions

fn (request: SetChatPermissionsRequest): Bool
fn (request: SetChatPermissionsRequest, opts: Map): Bool

setChatPermissions - Set the default permissions for all members of a group or supergroup. permissions is a ChatPermissions object (can_send_messages, can_send_photos, can_send_polls, can_invite_users, can_pin_messages, ...). The bot must be an administrator with can_restrict_members.

Example

::chat ::telegram::chat

// Read-only announcement group
::chat/set-chat-permissions(::chat/SetChatPermissionsRequest({
  chat_id: -1001234567890,
  permissions: {can_send_messages: false, can_send_polls: false, can_invite_users: true}
}))

set-chat-title

fn (request: SetChatTitleRequest): Bool
fn (request: SetChatTitleRequest, opts: Map): Bool

setChatTitle - Change the title of a group, supergroup, or channel. Titles can be 1-128 characters.

Example

::chat ::telegram::chat

::chat/set-chat-title(::chat/SetChatTitleRequest({
  chat_id: -1001234567890,
  title: "Release Announcements"
}))

unban-chat-member

fn (request: UnbanChatMemberRequest): Bool
fn (request: UnbanChatMemberRequest, opts: Map): Bool

unbanChatMember - Unban a previously banned user. Set only_if_banned: true to avoid accidentally unbanning an active member (which would remove them).

Example

::chat ::telegram::chat

::chat/unban-chat-member(::chat/UnbanChatMemberRequest({
  chat_id: -1001234567890,
  user_id: 123456789,
  only_if_banned: true
}))

unpin-all-chat-messages

fn (request: UnpinAllChatMessagesRequest): Bool
fn (request: UnpinAllChatMessagesRequest, opts: Map): Bool

unpinAllChatMessages - Remove all pinned messages from a chat.

Example

::chat ::telegram::chat

::chat/unpin-all-chat-messages(::chat/UnpinAllChatMessagesRequest({
  chat_id: -1001234567890
}))

unpin-chat-message

fn (request: UnpinChatMessageRequest): Bool
fn (request: UnpinChatMessageRequest, opts: Map): Bool

unpinChatMessage - Unpin a message. If message_id is not specified, the most recent pinned message is unpinned.

Example

::chat ::telegram::chat

::chat/unpin-chat-message(::chat/UnpinChatMessageRequest({
  chat_id: -1001234567890,
  message_id: 42
}))

Types

ApproveChatJoinRequestRequest

ApproveChatJoinRequestRequest type {
    chat_id: Any,
    user_id: Int
}

BanChatMemberRequest

BanChatMemberRequest type {
    chat_id: Any,
    user_id: Int,
    until_date: Int?,
    revoke_messages: Bool?
}

CreateChatInviteLinkRequest

CreateChatInviteLinkRequest type {
    chat_id: Any,
    name: Str?,
    expire_date: Int?,
    member_limit: Int?,
    creates_join_request: Bool?
}

DeclineChatJoinRequestRequest

DeclineChatJoinRequestRequest type {
    chat_id: Any,
    user_id: Int
}

ExportChatInviteLinkRequest

ExportChatInviteLinkRequest type {
    chat_id: Any
}

GetChatAdministratorsRequest

GetChatAdministratorsRequest type {
    chat_id: Any
}

GetChatMemberCountRequest

GetChatMemberCountRequest type {
    chat_id: Any
}

GetChatMemberRequest

GetChatMemberRequest type {
    chat_id: Any,
    user_id: Int
}

GetChatRequest

GetChatRequest type {
    chat_id: Any
}

LeaveChatRequest

LeaveChatRequest type {
    chat_id: Any
}

PinChatMessageRequest

PinChatMessageRequest type {
    chat_id: Any,
    message_id: Int,
    disable_notification: Bool?,
    business_connection_id: Str?
}

PromoteChatMemberRequest

PromoteChatMemberRequest type {
    chat_id: Any,
    user_id: Int,
    is_anonymous: Bool?,
    can_manage_chat: Bool?,
    can_delete_messages: Bool?,
    can_manage_video_chats: Bool?,
    can_restrict_members: Bool?,
    can_promote_members: Bool?,
    can_change_info: Bool?,
    can_invite_users: Bool?,
    can_post_messages: Bool?,
    can_edit_messages: Bool?,
    can_pin_messages: Bool?,
    can_post_stories: Bool?,
    can_edit_stories: Bool?,
    can_delete_stories: Bool?,
    can_manage_topics: Bool?
}

RestrictChatMemberRequest

RestrictChatMemberRequest type {
    chat_id: Any,
    user_id: Int,
    permissions: Map,
    until_date: Int?,
    use_independent_chat_permissions: Bool?
}

RevokeChatInviteLinkRequest

RevokeChatInviteLinkRequest type {
    chat_id: Any,
    invite_link: Str
}

SetChatDescriptionRequest

SetChatDescriptionRequest type {
    chat_id: Any,
    description: Str?
}

SetChatPermissionsRequest

SetChatPermissionsRequest type {
    chat_id: Any,
    permissions: Map,
    use_independent_chat_permissions: Bool?
}

SetChatTitleRequest

SetChatTitleRequest type {
    chat_id: Any,
    title: Str
}

UnbanChatMemberRequest

UnbanChatMemberRequest type {
    chat_id: Any,
    user_id: Int,
    only_if_banned: Bool?
}

UnpinAllChatMessagesRequest

UnpinAllChatMessagesRequest type {
    chat_id: Any
}

UnpinChatMessageRequest

UnpinChatMessageRequest type {
    chat_id: Any,
    message_id: Int?,
    business_connection_id: Str?
}