telegram api method · layer 229 · #fe2eda76

account.toggleNoPaidMessagesException

usable by users

Allow a user to send us messages without paying if paid messages » are enabled.

definition

account.toggleNoPaidMessagesException#fe2eda76 flags:# refund_charged:flags.0?true require_payment:flags.2?true parent_peer:flags.1?InputPeer user_id:InputUser = Bool;

parameters

nametypedescription
flags#Flags, see TL conditional fields
refund_chargedflags.0?trueIf set and require_payment is not set, refunds the amounts the user has already paid us to send us messages (directly or via a monoforum).
require_paymentflags.2?trueIf set, requires the user to pay in order to send us messages. Can only be set by monoforums, not users, i.e. parent_peer must be set if this flag is set; users must instead use the inputPrivacyKeyNoPaidMessages privacy setting to remove a previously added exemption. If not set, allows the user to send us messages without paying (can be unset by both monoforums and users).
parent_peerflags.1?InputPeerIf set, applies the setting within the monoforum aka direct messages » (pass the ID of the monoforum, not the ID of the associated channel).
user_idInputUserThe user to exempt or unexempt.

returns

Bool

errors (5)

codeerrordescription
400BUSINESS_CONNECTION_NOT_ALLOWEDThis method was invoked over a business connection using invokeWithBusinessConnection, but either (1) we're a user, and users cannot invoke methods over a business connection; (2) we're a bot, but business mode was disabled in @botfather or (3); we're a bot, but this method cannot be invoked over a business connection.
400PARENT_PEER_INVALIDThe specified parent_peer is invalid.
400UNSUPPORTEDrequire_payment cannot be *set* by users, only by monoforums: users must instead use the inputPrivacyKeyNoPaidMessages privacy setting to remove a previously added exemption.
400USER_ID_INVALIDThe provided user ID is invalid.
401AUTH_KEY_UNREGISTEREDThe specified authorization key is not registered in the system (for example, a PFS temporary key has expired).

history

present in layers 205–229

idlayers
#fe2eda76205–229