# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import logging
import re
import pyrogram
from pyrogram import enums, raw, types
from pyrogram.errors import NetworkMigrate, PhoneMigrate
log = logging.getLogger(__name__)
class SendPhoneNumberCode:
async def send_phone_number_code(
self: pyrogram.Client,
phone_number: str,
settings: types.PhoneNumberAuthenticationSettings | None = None,
type: enums.PhoneNumberCodeType = enums.PhoneNumberCodeType.AUTHENTICATION,
recaptcha_token: str | None = None,
# Deprecated params
current_number: bool | None = None,
allow_flashcall: bool | None = None,
allow_app_hash: bool | None = None,
allow_missed_call: bool | None = None,
allow_firebase: bool | None = None,
logout_tokens: list[bytes] | None = None,
token: str | None = None,
app_sandbox: bool | None = None,
) -> types.SentCode:
"""Sends a code to the specified phone number. Aborts previous phone number verification if there was one.
.. include:: /_includes/usable-by/users.rst
Parameters:
phone_number (``str``):
Phone number in international format (includes the country prefix).
settings (:obj:`~pyrogram.types.PhoneNumberAuthenticationSettings`, *optional*):
Settings for the authentication of the user's phone number.
type (:obj:`~pyrogram.enums.PhoneNumberCodeType`, *optional*):
Type of the request for which the code is sent.
Defaults to authentication.
current_number (``bool``, *optional*):
Deprecated, use *settings* instead.
Pass True if the phone number is the one the client is already signed in with.
allow_flashcall (``bool``, *optional*):
Deprecated, use *settings* instead.
Pass True if the code may be delivered as a flash call.
allow_app_hash (``bool``, *optional*):
Deprecated, use *settings* instead.
Pass True if the code may be delivered through the app hash.
allow_missed_call (``bool``, *optional*):
Deprecated, use *settings* instead.
Pass True if the code may be delivered as a missed call.
allow_firebase (``bool``, *optional*):
Deprecated, use *settings* instead.
Pass True if the code may be delivered through Firebase.
logout_tokens (List of ``bytes``, *optional*):
Deprecated, use *settings* instead.
Tokens of the sessions the user was signed out of, so the server can offer
a faster sign-in.
token (``str``, *optional*):
Deprecated, use *settings* instead.
Push notification token the code may be delivered to.
app_sandbox (``bool``, *optional*):
Deprecated, use *settings* instead.
Pass True to use the sandbox push service rather than the production one.
recaptcha_token (``str``, *optional*):
Token of the reCAPTCHA the server asked to solve before it sends the code.
Returns:
:obj:`~pyrogram.types.SentCode`: On success, returns information about the sent code.
Raises:
BadRequest: In case the phone number is invalid.
"""
phone_number = re.sub(r"\D", "", phone_number)
if settings is None:
settings = types.PhoneNumberAuthenticationSettings()
if any(
(
current_number is not None,
allow_flashcall is not None,
allow_app_hash is not None,
allow_missed_call is not None,
allow_firebase is not None,
logout_tokens is not None,
token is not None,
app_sandbox is not None,
)
):
if current_number is not None:
log.warning(
"`current_number` is deprecated and will be removed in future updates. Use `settings` instead."
)
if allow_flashcall is not None:
log.warning(
"`allow_flashcall` is deprecated and will be removed in future updates. Use `settings` instead."
)
if allow_app_hash is not None:
log.warning(
"`allow_app_hash` is deprecated and will be removed in future updates. Use `settings` instead."
)
if allow_missed_call is not None:
log.warning(
"`allow_missed_call` is deprecated and will be removed in future updates. Use `settings` instead."
)
if allow_firebase is not None:
log.warning(
"`allow_firebase` is deprecated and will be removed in future updates. Use `settings` instead."
)
if logout_tokens is not None:
log.warning(
"`logout_tokens` is deprecated and will be removed in future updates. Use `settings` instead."
)
if token is not None:
log.warning(
"`token` is deprecated and will be removed in future updates. Use `settings` instead."
)
if app_sandbox is not None:
log.warning(
"`app_sandbox` is deprecated and will be removed in future updates. Use `settings` instead."
)
firebase_settings = None
if allow_firebase:
firebase_settings = types.FirebaseAuthenticationSettingsAndroid()
if token is not None or app_sandbox is not None:
firebase_settings = types.FirebaseAuthenticationSettingsIos(
device_token=token, is_app_sandbox=app_sandbox
)
settings = types.PhoneNumberAuthenticationSettings(
allow_flash_call=allow_flashcall,
allow_missed_call=allow_missed_call,
is_current_phone_number=current_number,
allow_sms_retriever_api=allow_app_hash,
firebase_authentication_settings=firebase_settings,
authentication_tokens=logout_tokens,
)
while True:
try:
if type == enums.PhoneNumberCodeType.CHANGE:
rpc = raw.functions.account.SendChangePhoneCode(
phone_number=phone_number,
settings=settings.write(),
)
elif type == enums.PhoneNumberCodeType.VERIFY:
rpc = raw.functions.account.SendVerifyPhoneCode(
phone_number=phone_number,
settings=settings.write(),
)
else:
rpc = raw.functions.auth.SendCode(
phone_number=phone_number,
api_id=self.api_id,
api_hash=self.api_hash,
settings=settings.write(),
)
r = await self.invoke(rpc, recaptcha_token=recaptcha_token)
except (PhoneMigrate, NetworkMigrate) as e:
dc_option = await self.get_dc_option(e.value, ipv6=self.ipv6)
await self.session.stop()
self.session = await self.get_session(
dc_id=e.value,
server_address=dc_option.ip_address,
port=dc_option.port,
export_authorization=False,
temporary=True,
adopt_as_main=True,
)
await self.storage.dc_id(e.value)
await self.storage.server_address(dc_option.ip_address)
await self.storage.port(dc_option.port)
await self.storage.auth_key(self.session.auth_key)
else:
return types.SentCode._parse(r)