2024-02-10 15:29:33 +01:00
<!DOCTYPE html>
< html class = "" >
< head >
< meta charset = "utf-8" >
< title > Blocklist< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta property = "description" content = "Working with the blocklist." >
< meta property = "og:title" content = "Blocklist" >
< meta property = "og:image" content = "" >
< meta property = "og:description" content = "Working with the blocklist." >
< link rel = "icon" type = "image/svg+xml" href = "/img/website_icon.svg?4" >
< link rel = "apple-touch-icon" sizes = "180x180" href = "/img/apple-touch-icon.png" >
< link rel = "icon" type = "image/png" sizes = "32x32" href = "/img/favicon-32x32.png" >
< link rel = "icon" type = "image/png" sizes = "16x16" href = "/img/favicon-16x16.png" >
< link rel = "alternate icon" href = "/img/favicon.ico" type = "image/x-icon" / >
< link href = "/css/bootstrap.min.css?3" rel = "stylesheet" >
2024-08-02 02:44:36 +02:00
< link href = "/css/telegram.css?240" rel = "stylesheet" media = "screen" >
2024-02-10 15:29:33 +01:00
< style >
< / style >
< / head >
< body class = "preload" >
< div class = "dev_page_wrap" >
< div class = "dev_page_head navbar navbar-static-top navbar-tg" >
< div class = "navbar-inner" >
< div class = "container clearfix" >
< ul class = "nav navbar-nav navbar-right hidden-xs" > < li class = "navbar-twitter" > < a href = "https://twitter.com/telegram" target = "_blank" data-track = "Follow/Twitter" onclick = "trackDlClick(this, event)" > < i class = "icon icon-twitter" > < / i > < span > Twitter< / span > < / a > < / li > < / ul >
< ul class = "nav navbar-nav" >
< li > < a href = "//telegram.org/" > Home< / a > < / li >
< li class = "hidden-xs" > < a href = "//telegram.org/faq" > FAQ< / a > < / li >
< li class = "hidden-xs" > < a href = "//telegram.org/apps" > Apps< / a > < / li >
< li class = "active" > < a href = "/api" > API< / a > < / li >
< li class = "" > < a href = "/mtproto" > Protocol< / a > < / li >
< li class = "" > < a href = "/schema" > Schema< / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "container clearfix" >
< div class = "dev_page" >
< div id = "dev_page_content_wrap" class = " " >
< div class = "dev_page_bread_crumbs" > < ul class = "breadcrumb clearfix" > < li > < a href = "/api" > API< / a > < / li > < i class = "icon icon-breadcrumb-divider" > < / i > < li > < a href = "/api/block" > Blocklist< / a > < / li > < / ul > < / div >
< h1 id = "dev_page_title" > Blocklist< / h1 >
< div id = "dev_page_content" > <!-- scroll_nav -->
< p > Working with the blocklist.< / p >
< p > Scheme:< / p >
< pre > < code > < a href = '/constructor/peerBlocked' > peerBlocked< / a > #e8fd8014 peer_id:< a href = '/type/Peer' > Peer< / a > date:< a href = '/type/int' > int< / a > = < a href = '/type/PeerBlocked' > PeerBlocked< / a > ;
< a href = '/constructor/contacts.blocked' > contacts.blocked< / a > #ade1591 blocked:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/PeerBlocked' > PeerBlocked< / a > > chats:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/Chat' > Chat< / a > > users:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/User' > User< / a > > = < a href = '/type/contacts.Blocked' > contacts.Blocked< / a > ;
< a href = '/constructor/updatePeerBlocked' > updatePeerBlocked< / a > #ebe07752 flags:< a href = '/type/%23' > #< / a > blocked:flags.0?< a href = '/constructor/true' > true< / a > blocked_my_stories_from:flags.1?< a href = '/constructor/true' > true< / a > peer_id:< a href = '/type/Peer' > Peer< / a > = < a href = '/type/Update' > Update< / a > ;
---functions---
< a href = '/method/contacts.block' > contacts.block< / a > #2e2e8734 flags:< a href = '/type/%23' > #< / a > my_stories_from:flags.0?< a href = '/constructor/true' > true< / a > id:< a href = '/type/InputPeer' > InputPeer< / a > = < a href = '/type/Bool' > Bool< / a > ;
< a href = '/method/contacts.unblock' > contacts.unblock< / a > #b550d328 flags:< a href = '/type/%23' > #< / a > my_stories_from:flags.0?< a href = '/constructor/true' > true< / a > id:< a href = '/type/InputPeer' > InputPeer< / a > = < a href = '/type/Bool' > Bool< / a > ;
< a href = '/method/contacts.getBlocked' > contacts.getBlocked< / a > #9a868f80 flags:< a href = '/type/%23' > #< / a > my_stories_from:flags.0?< a href = '/constructor/true' > true< / a > offset:< a href = '/type/int' > int< / a > limit:< a href = '/type/int' > int< / a > = < a href = '/type/contacts.Blocked' > contacts.Blocked< / a > ;
< a href = '/method/contacts.setBlocked' > contacts.setBlocked< / a > #94c65c76 flags:< a href = '/type/%23' > #< / a > my_stories_from:flags.0?< a href = '/constructor/true' > true< / a > id:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/InputPeer' > InputPeer< / a > > limit:< a href = '/type/int' > int< / a > = < a href = '/type/Bool' > Bool< / a > ;< / code > < / pre >
< p > Use < a href = "/method/contacts.block" > contacts.block< / a > and < a href = "/method/contacts.unblock" > contacts.unblock< / a > to block and unblock peers. < / p >
< p > If the < code > my_stories_from< / code > is set, peers will be added/removed only to/from the story blocklist; otherwise, they will be added/removed to/from the the main blocklist. < / p >
< p > Peers in the story blocklist won't be able view your < a href = "/api/stories" > stories< / a > .< br >
Peers in the main blocklist won't be able to write messages to you, view your status, photo and stories. < / p >
< p > Adding or removing a peer from a blocklist will emit an < a href = "/constructor/updatePeerBlocked" > updatePeerBlocked< / a > to all currenly logged-in sessions (the peer we blocked/unblocked < em > won't< / em > receive any update). < / p >
< p > Use < a href = "/method/contacts.getBlocked" > contacts.getBlocked< / a > to fetch the list of blocked peers; as usual, the < code > my_stories_from< / code > flag can be used to fetch the story blocklist or the main blocklist, and the < code > offset< / code > /< code > limit< / code > parameters are used for < a href = "/api/offsets" > pagination »< / a > . < / p >
< p > < a href = "/method/contacts.setBlocked" > contacts.setBlocked< / a > may also be used to completely replace the contents of an entire blocklist in bulk: just pass the blocklist type in < code > my_stories_from< / code > , the full list of IDs to block in < code > id< / code > and the length of the list passed to < code > id< / code > in < code > limit< / code > : the server will completely replace the specified blocklist.< / p > < / div >
< / div >
< / div >
< / div >
< div class = "footer_wrap" >
< div class = "footer_columns_wrap footer_desktop" >
< div class = "footer_column footer_column_telegram" >
< h5 > Telegram< / h5 >
< div class = "footer_telegram_description" > < / div >
Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/faq" > About< / a > < / h5 >
< ul >
< li > < a href = "//telegram.org/faq" > FAQ< / a > < / li >
< li > < a href = "//telegram.org/privacy" > Privacy< / a > < / li >
< li > < a href = "//telegram.org/press" > Press< / a > < / li >
< / ul >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/apps#mobile-apps" > Mobile Apps< / a > < / h5 >
< ul >
< li > < a href = "//telegram.org/dl/ios" > iPhone/iPad< / a > < / li >
< li > < a href = "//telegram.org/android" > Android< / a > < / li >
< li > < a href = "//telegram.org/dl/web" > Mobile Web< / a > < / li >
< / ul >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/apps#desktop-apps" > Desktop Apps< / a > < / h5 >
< ul >
< li > < a href = "//desktop.telegram.org/" > PC/Mac/Linux< / a > < / li >
< li > < a href = "//macos.telegram.org/" > macOS< / a > < / li >
< li > < a href = "//telegram.org/dl/web" > Web-browser< / a > < / li >
< / ul >
< / div >
< div class = "footer_column footer_column_platform" >
< h5 > < a href = "/" > Platform< / a > < / h5 >
< ul >
< li > < a href = "/api" > API< / a > < / li >
< li > < a href = "//translations.telegram.org/" > Translations< / a > < / li >
< li > < a href = "//instantview.telegram.org/" > Instant View< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "footer_columns_wrap footer_mobile" >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/faq" > About< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/blog" > Blog< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/apps" > Apps< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "/" > Platform< / a > < / h5 >
< / div >
< div class = "footer_column" >
2024-02-14 21:54:52 +01:00
< h5 > < a href = "//telegram.org/press" > Press< / a > < / h5 >
2024-02-10 15:29:33 +01:00
< / div >
< / div >
< / div >
< / div >
< script src = "/js/main.js?47" > < / script >
< script src = "/js/jquery.min.js?1" > < / script >
< script src = "/js/bootstrap.min.js?1" > < / script >
< script > w i n d o w . i n i t D e v P a g e N a v & & i n i t D e v P a g e N a v ( ) ;
backToTopInit("Go up");
removePreloadInit();
< / script >
< / body >
< / html >