How to get a CNContact phone number(s) as string in Swift?

Question

I am attempting to retrieve the names and phone number(s) of all contacts and put them into arrays with Swift in iOS. I have made it this far:

func findContacts() -> [CNContact] {

    marrContactsNumber.removeAllObjects()
    marrContactsName.removeAllObjects()

    let store = CNContactStore()

    let keysToFetch = [CNContactGivenNameKey, CNContactFamilyNameKey, CNContactPhoneNumbersKey]

    let fetchRequest = CNContactFetchRequest(keysToFetch: keysToFetch)

    var contacts = [CNContact]()

    do {
        try store.enumerateContactsWithFetchRequest(fetchRequest, usingBlock: { (let contact, let stop) -> Void in
            contacts.append(contact)

            self.marrContactsName.addObject(contact.givenName + " " + contact.familyName)

            self.marrContactsNumber.addObject(contact.phoneNumbers)

            print(contact.phoneNumbers)
    }
    catch let error as NSError {
        print(error.localizedDescription)
    }

    print(marrContactsName.count)
    print(marrContactsNumber.count)

    return contacts
}

Once completed, marrContactsName contains an array of all my contacts' names exactly as expected. i.e. "John Doe". However, marrContactsNumber returns an array of values like

[<CNLabeledValue: 0x158a19950: identifier=F831DC7E-5896-420F-AE46-489F6C14DA6E,
label=_$!<Work>!$_, value=<CNPhoneNumber: 0x158a19640: countryCode=us, digits=6751420000>>,
<CNLabeledValue: 0x158a19a80: identifier=ECD66568-C6DD-441D-9448-BDEDDE9A68E1,
label=_$!<Work>!$_, value=<CNPhoneNumber: 0x158a199b0: countryCode=us, digits=5342766455>>]

I would like to know how to retrieve JUST the phone number(s) as a string value(s) i.e. "XXXXXXXXXX". Basically, how to call for the digit(s) value. Thanks!

score 40 · Accepted Answer · answered Apr 01 '16 at 01:20

40

I found the solution: (contact.phoneNumbers[0].value as! CNPhoneNumber).valueForKey("digits") as! String

answered Apr 01 '16 at 01:20

Baylor Mitchell

1,029
1
11
19

26

valueForKey("digits" ) is not a public API, you should use the property stringValue : `(contact.phoneNumbers.first?.value as? CNPhoneNumber)?.stringValue` – HamzaGhazouani Jun 15 '16 at 10:32
6

From , HamzaGhazouani in swift 3, `((contact.phoneNumbers.first?.value)! as CNPhoneNumber).stringValue` – Rajamohan S Sep 27 '16 at 14:31
So this has worked for me in all cases except for when there is the country prefix in front ( ' +1' ). I've been digging into that but can't find what I'm looking for. Anyone know how to ONLY get the 10 digit US number? – Jake Feb 17 '18 at 04:30
Nevermind. I decided to do this : ` var phoneNumber = (number.value as! CNPhoneNumber).value(forKey: "digits") as! String if phoneNumber .contains("+1") { phoneNumber = "\(phoneNumber.dropFirst(2))" } ` And I got the result I wanted – Jake Feb 17 '18 at 04:42
Hello everyone, Can you tell me this code for xamarin.ios? – Sumit Mishra Jan 28 '20 at 06:46
FWIW I found the answer using the valueForKey("digits") give me better results in cleaner string formatting than the .stringvalue. Yes It's not a public API but I'll take my chances for now. – AMC08 Apr 12 '20 at 22:51

score 23 · Answer 2 · edited Feb 23 '17 at 09:24

23

you can get contact.phoneNumbers from CNLabeledValue:

for phoneNumber in contact.phoneNumbers {
  if let number = phoneNumber.value as? CNPhoneNumber,
      let label = phoneNumber.label {
      let localizedLabel = CNLabeledValue.localizedStringForLabel(label)
      print("\(localizedLabel)  \(number.stringValue)")
  }
}

edited Feb 23 '17 at 09:24

Milan Kamilya

2,188
1
31
44

answered Apr 27 '16 at 10:02

Telember

455
6
24

9

One more hoop to jump through. Line 4 becomes `let localizedLabel = CNLabeledValue.localizedString(forLabel: label)` – AlexT Apr 11 '17 at 18:12

Sujay U N · Answer 3 · 2017-08-24T18:38:54.577

/* Get only first mobile number */

    let MobNumVar = (contact.phoneNumbers[0].value as! CNPhoneNumber).valueForKey("digits") as! String
    print(MobNumVar)

/* Get all mobile number */

    for ContctNumVar: CNLabeledValue in contact.phoneNumbers
    {
        let MobNumVar  = (ContctNumVar.value as! CNPhoneNumber).valueForKey("digits") as? String
        print(MobNumVar!)
    }

 /* Get mobile number with mobile country code */

    for ContctNumVar: CNLabeledValue in contact.phoneNumbers
    {
        let FulMobNumVar  = ContctNumVar.value as! CNPhoneNumber
        let MccNamVar = FulMobNumVar.valueForKey("countryCode") as? String
        let MobNumVar = FulMobNumVar.valueForKey("digits") as? String

        print(MccNamVar!)
        print(MobNumVar!)
    }

very handy (though somewhat unorthodox variable naming scheme) — woody121, Nov 03 '17 at 09:22

score 4 · Answer 4 · answered Feb 27 '18 at 17:16

4

Here is how you do it in swift 4

func contactPicker(_ picker: CNContactPickerViewController, didSelect contactProperty: CNContactProperty) {

    if let phoneNo = contactProperty.value as? CNPhoneNumber{
        txtPhone.text = phoneNo.stringValue
    }else{
        txtPhone.text=""
    }
}

answered Feb 27 '18 at 17:16

1394

41
1

I used for selecting just "numberProperty" and this helped me. thanks – Mahdi Moqadasi Oct 07 '19 at 10:13

digitalHound · Answer 5 · 2020-03-13T21:08:39.313

Here's a Swift 5 solution.

import Contacts

func sendMessageTo(_ contact: CNContact) {

    let validTypes = [
        CNLabelPhoneNumberiPhone,
        CNLabelPhoneNumberMobile,
        CNLabelPhoneNumberMain
    ]

    let numbers = contact.phoneNumbers.compactMap { phoneNumber -> String? in
        guard let label = phoneNumber.label, validTypes.contains(label) else { return nil }
        return phoneNumber.value.stringValue
    }

    guard !numbers.isEmpty else { return }

    // process/use your numbers for this contact here
    DispatchQueue.main.async {
        self.sendSMSText(numbers)
    }
}

You can find available values for the validTypes array in the CNPhoneNumber header file.

They are:

CNLabelPhoneNumberiPhone
CNLabelPhoneNumberMobile
CNLabelPhoneNumberMain
CNLabelPhoneNumberHomeFax
CNLabelPhoneNumberWorkFax
CNLabelPhoneNumberOtherFax
CNLabelPhoneNumberPager

score 1 · Answer 6 · answered Mar 31 '16 at 23:56

The definition of a CNLabeledValue:

The CNLabeledValue class is a thread-safe class that defines an immutable value object that combines a contact property value with a label. For example, a contact phone number could have a label of Home, Work, iPhone, etc.

CNContact.phoneNumbers is an array of CNLabeledValues and each CNLabeledValue has a label and a value.

To print the phoneNumbers corresponding to a CNContact you can try:

for phoneNumber in contact.phoneNumbers {
    print("The \(phoneNumber.label) number of \(contact.givenName) is: \(phoneNumber.value)")
}

Thank you for the response. Now, `phoneNumber.value` is returning ``. How can I get it to just show the digits? — Baylor Mitchell, Apr 01 '16 at 00:55

score 1 · Answer 7 · answered Nov 25 '16 at 10:53

1

In swift 3 you can get direclty

 if item.isKeyAvailable(CNContactPhoneNumbersKey){
        let phoneNOs=item.phoneNumbers
        let phNo:String
        for item in phoneNOs{
            print("Phone Nos \(item.value.stringValue)")
        }

answered Nov 25 '16 at 10:53

Mahesh Giri

1,810
19
27

score 1 · Answer 8 · answered Oct 31 '19 at 11:52

1

Keeping things simple:

let phoneNumbers: [String] = contact.phoneNumbers.compactMap { (phoneNumber: CNLabeledValue) in
    guard let number = phoneNumber.value.value(forKey: "digits") as? String else { return nil }
    return number
}

answered Oct 31 '19 at 11:52

Adam Waite

19,175
22
126
148

score 1 · Answer 9 · answered Feb 14 '20 at 07:30

for Swift 5+

func removeSpecialCharactersFromContactNumberOfUser(_ contactNo : String) -> String? {

    let digits = CharacterSet(charactersIn: "0123456789").inverted
    let modifiedContactNo = contactNo.components(separatedBy: digits).joined(separator: "")

    if modifiedContactNo.count > 9 {

        return modifiedContactNo

    } else {

        return nil
    }
}

var number = phone.value.stringValue
number = number.starts(with: "+91") ? number.replacingOccurrences(of: "+91", with: "") : number

if let formattedNumber = removeSpecialCharactersFromContactNumberOfUser(number)  {
    //use this formattedNumber                 
}

This is to remove +91 from your phone number and it's working fine.

Asim Khan · Answer 10 · 2017-02-23T17:35:53.017

0

Swift 3 "_$!<Mobile>!$_" This item is written to create difference as well as putting a piece of opportunity to rely on various options.

for con in contacts
{
    for num in con.phoneNumbers
    {
        if num.label == "_$!<Mobile>!$_"    //Please Don't Change this!
        {
            self.contactNames.append(con.givenName)
            self.contactNums.append(num.value.stringValue)
            break
        }
        else
        {
            continue
        }
    }
}

Here we have num.value.stringValue

edited Feb 23 '17 at 17:35

answered Feb 23 '17 at 04:43

Asim Khan

508
1
7
21

2

Hey @Aasim Putting a string in coding is a bad practice if you may let like CNLabelPhoneNumberMobile, CNLabelPhoneNumberiPhone, CNLabelPhoneNumberHomeFax. – Milan Kamilya Feb 23 '17 at 19:17

score 0 · Answer 11 · answered Apr 08 '21 at 11:08

fetch without country code from phone contacts and also removed unwanted text such as dash, spaces etc.. and also post from phonetextfield import ContactsUI var phoneString:String!

func contactPicker(_ picker: CNContactPickerViewController, didSelect contact: CNContact) {
        let numbers = contact.phoneNumbers.first
        let a = (numbers?.value)?.stringValue ?? ""
        let myString = a
        let formattedString = myString.replacingOccurrences(of: " ", with: "")
        let newFormattedString = formattedString.replacingOccurrences(of: "(", with: "")
        let formatstring = newFormattedString.replacingOccurrences(of: ")", with: "")
        let  last10  = formatstring.replacingOccurrences(of: "-", with: "")
        phoneString = String(last10.suffix(10))
        phonetextField.text = phoneString
        
    }
    
    func contactPickerDidCancel(_ picker: CNContactPickerViewController) {
        self.dismiss(animated: true, completion: nil)
    }
   @IBAction func inviteButton(_ sender : Any)
    {
        if phoneString == nil{
            phoneString =  phonetextField.text! //fetching from phonetextfield
            Phone = phoneString
        }
        else  {
            Phone = phoneString //fetching from phone contacts
        
        }
      }

How to get a CNContact phone number(s) as string in Swift?

11 Answers11

Linked

Related