The contacts object provides access to the device contacts database.

Important privacy note: Collection and use of contact data raises important privacy issues. Your app's privacy policy should discuss how the app uses contact data and whether it is shared with any other parties. Contact information is considered sensitive because it reveals the people with whom a person communicates. Therefore, in addition to your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing or using contact data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for OK and No Thanks). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing contact data. A clear and easy-to-understand user experience surrounding the use of contact data will help avoid user confusion and perceived misuse of contact data. For more information, please see the Privacy Guide.




Accessing the Feature

As of version 3.0, Cordova implements device-level APIs as plugins. Use the CLI's plugin command, described in The Command-line Interface, to add or remove this feature for a project:

    $ cordova plugin add org.apache.cordova.contacts
    $ cordova plugin ls
    [ 'org.apache.cordova.contacts' ]
    $ cordova plugin rm org.apache.cordova.contacts

These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:

  • Android

      (in app/res/xml/config.xml)
      <feature name="Contacts">
          <param name="android-package" value="org.apache.cordova.contacts.ContactManager" />
      (in app/AndroidManifest.xml)
      <uses-permission android:name="android.permission.READ_CONTACTS" />
      <uses-permission android:name="android.permission.WRITE_CONTACTS" />
      <uses-permission android:name="android.permission.GET_ACCOUNTS" />
  • BlackBerry WebWorks

      (in www/plugins.xml)
      <feature name="Contact">
          <param name="blackberry-package" value="org.apache.cordova.pim.Contact" />
      (in www/config.xml)
      <feature id="blackberry.find"        required="true" version="" />
      <feature id="blackberry.identity"    required="true" version="" />
      <feature id="blackberry.pim.Address" required="true" version="" />
      <feature id="blackberry.pim.Contact" required="true" version="" />
  • iOS (in config.xml)

      <feature name="Contacts">
          <param name="ios-package" value="CDVContacts" />
  • Windows Phone

      (in Properties/WPAppManifest.xml)
          <Capability Name="ID_CAP_CONTACTS" />

    Reference: Application Manifest for Windows Phone

Some platforms may support this feature without requiring any special configuration. See Platform Support in the Overview section.