1. Workcloud Communication Voice Client Programmer Guide
  2. Actions
  3. Import Contacts
  • Workcloud Communication Voice Client Programmer Guide
Import Contacts

Import Contacts

Import contacts from a CSV file. The file is stored on the device or on a server.

Prerequisites

  • The Zebra Voice Client is loaded to the device.
  • The CSV file is stored on the device or on a server.
  • All versions of Zebra Voice Client 9.0 support these intents.

Intent Definition

Name
Description
Action
wfc.voice.SYNC_CONTACTS
Intent Type
startActivity
Extra 0
Location of the contacts CSV file
          Type
String
          Name
contacts_url
          Value
URL of a downloadable CSV file or a file name on the SD card
Extra 1
This extra parameter specifies if the existing contacts should be deleted or not before applying the CSV file
          Type
boolean
          Name
reset
          Value
true
: the app deletes all existing contacts prior to loading the CSV file
false
: existing contacts are not deleted

ADB Examples

To load a file stored on the device, and clear existing contacts before applying the file:
$ adb shell am start -a wfc.voice.SYNC_CONTACTS --es contacts_url /sdcard/ contacs.csv --ez reset true
To load a file stored on a network, and leave existing contacts:
$ adb shell am start -a wfc.voice.SYNC_CONTACTS --es contacts_url https://example.com/voice/contacts/1234 --ez reset false

Import Contacts Template

This section provides a description and example of the CSV file template used to import contacts.
  • The following fields are required:
    • contactId
      –Use a unique integer for each contact. If a contact already exists with the same contactId, the existing record is updated. To delete a contact, set this to a value less than zero.
    • firstName
      –First name
    • lastName
      –Last name
  • Provide at least one of the following:
    • cellNumber
      –Cell phone number
    • officeNumber
      –Office phone number
    • homeNumber
      –Home phone number

Optional Fields

  • group
    –List group names separated by semicolons.
  • ringtone
    –Provide a ringtone for the contact using one of the following value types:
    • Name
      –Name of an existing Android ringtone
    • URL
      –Link to the downloadable music file
    • Filename
      –Path to the music file on the SD card
    • Empty string–Leave blank to use the default ringtone.
  • photo
    –URL to a downloadable image file or the path to a file on the SD card. Supported image formats are PNG and JPG.
Sample Import
group
contact Id
first Name
last Name
cell Number
office Number
home Number
ringtone
photo
Work; Home; Paint
1
Mike
Smith
2725
847-123- 4560
6540
/sdcard/WFConnect /pic1.jpg
Work; Home
2
John
Page
2726
6541
/sdcard/WFConnect /pic2.jpg
Paint
3
Frank
Flyer
2727
/sdcard/WFConnect /ring4.ogg
Electronics
4
Emilia
Kratzer
2728
6542
/sdcard/WFConnect /pic4.jpg
-5
Kate
Perry
2729
The column headings in the import CSV file must be one word. For example,
contact Id
 should be
contactId
. The spaces in the sample are to format the table.