zulip/zulip

Add phone number custom profile field type

Open

#23,787 opened on Dec 7, 2022

View on GitHub
 (10 comments) (0 reactions) (1 assignee)Python (7,339 forks)batch import
area: settings (admin/org)help wantedin progressnew feature

Repository metrics

Stars
 (19,672 stars)
PR merge metrics
 (Avg merge 36d 6h) (110 merged PRs in 30d)

Description

At present, the best option for a phone number custom profile field is to use the "short text" field type. It would be helpful to have a dedicated custom profile field type for phone numbers.

This field should have phone number validation. Ideally, it would also auto-format correctly as you type based on the country code.

The API should be designed in such a way that clients (e.g., mobile) that don't know about this field type can just display it as they would a short text field.

Technical notes:

  • As discussed on CZO, for validating the phone number:

we should certainly be using something like libphonenumber or one of its derivatives (js without the geocoding which we don't need, python, python without the geocoding which we don't need).

  • See here for info on how we added the pronouns custom field type, which is a good reference for how to implement this issue.

  • We may want to automatically migrate custom profile fields with "phone" in their title to this field type when it has been implemented.

Contributor guide