Skip to content

checkChatInviteLink

Sahri Riza Umami edited this page Jun 22, 2018 · 4 revisions

Checks the validity of an invite link for a chat and returns information about the corresponding chat.

checkChatInviteLink(invite_link, callback, data)
Field Type Description
invite_link string Invite link to be checked; should begin with "https://t.me/joinchat/", "https://telegram.me/joinchat/", or "https://telegram.dog/joinchat/"

Example

  • Checks chat invite link https://t.me/joinchat/AbC12dEfgh3IJKLMnopQrS for its validness.

    checkChatInviteLink('https://t.me/joinchat/AbC12dEfgh3IJKLMnopQrS')

    Response:

    {
      ["@type"] = "chatInviteLinkInfo",
      chat_id = 0,
      is_public = false,
      member_count = 5,
      member_user_ids = {
        11111111,
        222222222,
        33333333,
        444444444,
        [0] = 55555555
      },
      photo = {
        ["@type"] = "chatPhoto",
        big = {
          ["@type"] = "file",
          expected_size = 0,
          id = 8,
          ["local"] = {
            ["@type"] = "localFile",
            can_be_deleted = false,
            can_be_downloaded = true,
            downloaded_prefix_size = 0,
            downloaded_size = 0,
            is_downloading_active = false,
            is_downloading_completed = false,
            path = ""
          },
          remote = {
            ["@type"] = "remoteFile",
            id = "AQADBQATaRLMMgAES5f-JJ_5sW30-gMAAQI",
            is_uploading_active = false,
            is_uploading_completed = true,
            uploaded_size = 0
          },
          size = 0
        },
        small = {
          ["@type"] = "file",
          expected_size = 0,
          id = 7,
          ["local"] = {
            ["@type"] = "localFile",
            can_be_deleted = false,
            can_be_downloaded = true,
            downloaded_prefix_size = 0,
            downloaded_size = 0,
            is_downloading_active = false,
            is_downloading_completed = false,
            path = ""
          },
          remote = {
            ["@type"] = "remoteFile",
            id = "AQADBQATaRLMMgAESFh36L2q-QTy-gMAAQI",
            is_uploading_active = false,
            is_uploading_completed = true,
            uploaded_size = 0
          },
          size = 0
        }
      },
      title = "Supergroup PlayGround",
      type = {
        ["@type"] = "chatTypeSupergroup",
        is_channel = false,
        supergroup_id = 0
      }
    }

Frequently Asked Questions
The Functions

Clone this wiki locally