diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2023-05-05 15:51:46 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-05 15:51:46 +0100 |
| commit | 7c95b65873c7a858388b9c99c7e9e15dc5ccb2b5 (patch) | |
| tree | f50dd2288c2561afbfeed965e02563a9711e5ce9 /synapse/util/msisdn.py | |
| parent | Factor out an `is_mine_server_name` method (#15542) (diff) | |
| download | synapse-7c95b65873c7a858388b9c99c7e9e15dc5ccb2b5.tar.xz | |
Clean up and clarify "Create or modify Account" Admin API documentation (#15544)
Diffstat (limited to 'synapse/util/msisdn.py')
| -rw-r--r-- | synapse/util/msisdn.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/synapse/util/msisdn.py b/synapse/util/msisdn.py index 1046224f15..3721a1558e 100644 --- a/synapse/util/msisdn.py +++ b/synapse/util/msisdn.py @@ -22,12 +22,16 @@ def phone_number_to_msisdn(country: str, number: str) -> str: Takes an ISO-3166-1 2 letter country code and phone number and returns an msisdn representing the canonical version of that phone number. + + As an example, if `country` is "GB" and `number` is "7470674927", this + function will return "447470674927". + Args: country: ISO-3166-1 2 letter country code number: Phone number in a national or international format Returns: - The canonical form of the phone number, as an msisdn + The canonical form of the phone number, as an msisdn. Raises: SynapseError if the number could not be parsed. """ |