Cluster · разработчикам
TL contacts · методы
Каталог и общие правила · Справочник SDK
contacts.AcceptContact
Аргументы
id: 'TypeInputUser', обязательный.
Результат
Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.AcceptContact(id=id)contacts.AddContact
Аргументы
add_phone_privacy_exception: Optional[bool], необязательный; значение None.first_name: str, обязательный.id: 'TypeInputUser', обязательный.last_name: str, обязательный.note: Optional[ForwardRef('TypeTextWithEntities')], необязательный; значение None.phone: str, обязательный.
Результат
Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.AddContact(first_name=first_name, id=id, last_name=last_name, phone=phone)contacts.Block
Аргументы
id: 'TypeInputPeer', обязательный.my_stories_from: Optional[bool], необязательный; значение None.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.Block(id=id)contacts.BlockFromReplies
Аргументы
delete_history: Optional[bool], необязательный; значение None.delete_message: Optional[bool], необязательный; значение None.msg_id: int, обязательный.report_spam: Optional[bool], необязательный; значение None.
Результат
Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.BlockFromReplies(msg_id=msg_id)contacts.DeleteByPhones
Аргументы
phones: List[str], обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.DeleteByPhones(phones=phones)contacts.DeleteContacts
Аргументы
id: List[ForwardRef('TypeInputUser')], обязательный.
Результат
Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.DeleteContacts(id=id)contacts.EditCloseFriends
Аргументы
id: List[int], обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.EditCloseFriends(id=id)contacts.ExportContactToken
Аргументы
Нет.
Результат
ExportedContactToken, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ExportContactToken()contacts.GetBirthdays
Аргументы
Нет.
Результат
contacts.ContactBirthdays, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetBirthdays()contacts.GetBlocked
Аргументы
limit: int, обязательный.my_stories_from: Optional[bool], необязательный; значение None.offset: int, обязательный.
Результат
contacts.Blocked, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetBlocked(limit=limit, offset=offset)contacts.GetContactIDs
Аргументы
hash: int, обязательный.
Результат
Vector<int>, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetContactIDs(hash=hash)contacts.GetContacts
Аргументы
hash: int, обязательный.
Результат
contacts.Contacts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetContacts(hash=hash)contacts.GetLocated
Аргументы
background: Optional[bool], необязательный; значение None.geo_point: 'TypeInputGeoPoint', обязательный.self_expires: Optional[int], необязательный; значение None.
Результат
Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetLocated(geo_point=geo_point)contacts.GetSaved
Аргументы
Нет.
Результат
Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetSaved()contacts.GetSponsoredPeers
Аргументы
q: str, обязательный.
Результат
contacts.SponsoredPeers, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetSponsoredPeers(q=q)contacts.GetStatuses
Аргументы
Нет.
Результат
Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetStatuses()contacts.GetTopPeers
Аргументы
bots_app: Optional[bool], необязательный; значение None.bots_guestchat: Optional[bool], необязательный; значение None.bots_inline: Optional[bool], необязательный; значение None.bots_pm: Optional[bool], необязательный; значение None.channels: Optional[bool], необязательный; значение None.correspondents: Optional[bool], необязательный; значение None.forward_chats: Optional[bool], необязательный; значение None.forward_users: Optional[bool], необязательный; значение None.groups: Optional[bool], необязательный; значение None.hash: int, обязательный.limit: int, обязательный.offset: int, обязательный.phone_calls: Optional[bool], необязательный; значение None.
Результат
contacts.TopPeers, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.GetTopPeers(hash=hash, limit=limit, offset=offset)contacts.ImportContactToken
Аргументы
token: str, обязательный.
Результат
User, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ImportContactToken(token=token)contacts.ImportContacts
Аргументы
contacts: List[ForwardRef('TypeInputContact')], обязательный.
Результат
contacts.ImportedContacts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ImportContacts(contacts=contacts)contacts.ResetSaved
Аргументы
Нет.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ResetSaved()contacts.ResetTopPeerRating
Аргументы
category: 'TypeTopPeerCategory', обязательный.peer: 'TypeInputPeer', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ResetTopPeerRating(category=category, peer=peer)contacts.ResolvePhone
Аргументы
phone: str, обязательный.
Результат
contacts.ResolvedPeer, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ResolvePhone(phone=phone)contacts.ResolveUsername
Аргументы
referer: Optional[str], необязательный; значение None.username: str, обязательный.
Результат
contacts.ResolvedPeer, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ResolveUsername(username=username)contacts.Search
Аргументы
bots: Optional[bool], необязательный; значение None.broadcasts: Optional[bool], необязательный; значение None.limit: int, обязательный.q: str, обязательный.
Результат
contacts.Found, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.Search(limit=limit, q=q)contacts.SetBlocked
Аргументы
id: List[ForwardRef('TypeInputPeer')], обязательный.limit: int, обязательный.my_stories_from: Optional[bool], необязательный; значение None.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.SetBlocked(id=id, limit=limit)contacts.TL
Аргументы
Нет.
Результат
Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.TL()contacts.ToggleTopPeers
Аргументы
enabled: bool, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.ToggleTopPeers(enabled=enabled)contacts.Unblock
Аргументы
id: 'TypeInputPeer', обязательный.my_stories_from: Optional[bool], необязательный; значение None.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.Unblock(id=id)contacts.UpdateContactNote
Аргументы
id: 'TypeInputUser', обязательный.note: 'TypeTextWithEntities', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.contacts.UpdateContactNote(id=id, note=note)