2017-03-13 13:27:51 -04:00
|
|
|
#
|
2023-11-21 15:29:58 -05:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 06:26:48 -05:00
|
|
|
# Copyright 2017 Vector Creations Ltd
|
2023-11-21 15:29:58 -05:00
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2017-03-13 13:27:51 -04:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
|
|
|
import phonenumbers
|
2018-07-09 02:09:20 -04:00
|
|
|
|
2017-03-13 13:27:51 -04:00
|
|
|
from synapse.api.errors import SynapseError
|
|
|
|
|
|
|
|
|
2021-05-24 15:32:01 -04:00
|
|
|
def phone_number_to_msisdn(country: str, number: str) -> str:
|
2017-03-13 13:27:51 -04:00
|
|
|
"""
|
|
|
|
Takes an ISO-3166-1 2 letter country code and phone number and
|
|
|
|
returns an msisdn representing the canonical version of that
|
|
|
|
phone number.
|
2023-05-05 10:51:46 -04:00
|
|
|
|
|
|
|
As an example, if `country` is "GB" and `number` is "7470674927", this
|
|
|
|
function will return "447470674927".
|
|
|
|
|
2017-03-13 13:27:51 -04:00
|
|
|
Args:
|
2021-05-24 15:32:01 -04:00
|
|
|
country: ISO-3166-1 2 letter country code
|
|
|
|
number: Phone number in a national or international format
|
2017-03-13 13:27:51 -04:00
|
|
|
|
|
|
|
Returns:
|
2023-05-05 10:51:46 -04:00
|
|
|
The canonical form of the phone number, as an msisdn.
|
2017-03-13 13:27:51 -04:00
|
|
|
Raises:
|
2021-05-24 15:32:01 -04:00
|
|
|
SynapseError if the number could not be parsed.
|
2017-03-13 13:27:51 -04:00
|
|
|
"""
|
|
|
|
try:
|
|
|
|
phoneNumber = phonenumbers.parse(number, country)
|
|
|
|
except phonenumbers.NumberParseException:
|
|
|
|
raise SynapseError(400, "Unable to parse phone number")
|
|
|
|
return phonenumbers.format_number(phoneNumber, phonenumbers.PhoneNumberFormat.E164)[
|
|
|
|
1:
|
|
|
|
]
|