Overview

Last Updated : May 09, 2024 |

Contact attributes are properties of contact data. You can filter contact data based on contact attributes.

The following are the two types of contact attributes:
  • Predefined Attributes

  • Custom Attributes

Predefined Attributes

Predefined attributes are the built-in attributes. These attributes are most commonly used attributes and are grouped together. The predefined attributes are of the following two types:
  • System attributes with the system-generated values: The values are generated by POM.

  • System attributes with user-defined values: The users need to specify the value.

Table 1: System attributes with the system-generated values

Attribute name

Description

Attribute name to be used in import file header

Attribute name to be used in Web Service

Added On

The time when a new contact was imported, uploaded, or added into a contact list.

Note:

The value of the addedOn attribute for all the contacts imported earlier to POM 4.0.2 Service Pack 3 will be set to the time of upgrade to POM 4.0.2 Service Pack 3.

-

addedOn

Counter

The number of times the contact has been successfully attempted.

-

counter

Last Modified On

The last time when the contact was modified.

-

lastModifiedOn

Last Address Dialed Attribute Name

The attribute name of the address by which the contact was last dialed.

-

lastAddrDialedAttrName

Last Handled By Agent ID

The Agent ID of the agent who last handled the contact.

-

lastHandledByAgentId

Last Nuisance Call Time

The last time when the contact was in a nuisance call.

-

lastNuisanceCallTime

Last Attempt Time

The last time when the contact was attempted.

-

-

Last Successful Attempt Time

The last time when the contact attempt was successful.

-

-

Last Completion Code

The last completion code of the contact.

-

-

Table 2: System attributes with user-defined values

Attribute name

Description

Attribute name to be used in import file header

Attribute name to be used in Web Service

ID

The unique identification for the contact. Id is a mandatory attribute.

Note:

Id must be the first attribute to be mentioned in the .csv file.

Id

userContactID

Title Predefined

The salutation that is used before the first name of the contact. For example, Mr, Mrs., Dr.

titlepredefined

title

First Name

The first name of the contact.

Note:

POM Campaign Detail report displays this attribute value for the user to identify the contact.

firstname

firstName

Last Name

The last name of the contact.

Note:

POM Campaign Detail report displays this attribute value for the user to identify the contact.

lastname

lastName

Address Line 1 Predefined

The address of the contact.

addrline1predefined

addressLine1

Address Line 2 Predefined

The address of the contact.

addrline2predefined

addressLine2

Address Line 3 Predefined

The address of the contact.

addrline3predefined

addressLine3

Address Line 4 Predefined

The address of the contact.

addrline4predefined

addressLine4

Address Line 5 Predefined

The address of the contact.

addrline5predefined

addressLine5

Phone 1

The phone number of the contact.

phonenumber1

phoneNumber1

Phone 1 Country Code

The country code associated with the Phone 1 attribute.

phonenumber1ctrycode

phoneNumber1CtryCode

Phone 1 State

The state associated with the Phone 1 attribute.

phonenumber1state

phoneNumber1State

Phone 1 Wireless

Indicates whether the Phone 1 attribute is of a wireless phone.

phonenumber1wireless

phoneNumber1Wireless

Time Zone

The time zone associated with the Phone 1 attribute.

timezone

phoneNumber1TimeZone

Phone 1 Allowed Time

Use this attribute to specify specific hours and days of the week during which phone 1 can be dialed.

For example, your customer allows you to call on phone 1 only during specific hours and days of the week.

Use the following example format to specify the allowed time:

0-6.12:00.18:00

Where:

  • 0-6 represent days of the week. Where, 0 represents Sunday and 6 represents Saturday.

  • 12:00 represents the beginning of the allowed time.

  • 18:00 represents the end of the allowed time.

Hence, in the preceding example, the allowed time for phone 1 is from Sunday through Saturday from 12:00 to 18:00.

To specify different allowed times for different days of the week, use a space as a separator.

Example 1:

1-5.10:00.16:00 6.12:00.14:00 0.10:00.11:00

In the preceding example, the allowed time to dial phone 1 is:

  • Monday through Friday from 10:00 to 16:00.

  • Saturday from 12:00 to 14:00.

  • Sunday from 10:00 to 11:00.

Example 2:

1-5.10:00.16:00 3.17:00.18:00

In the preceding example, the allowed time to dial phone 1 is:

  • Monday, Tuesday, Thursday, and Friday from 10:00 to 16:00.

  • Because the allowed time for Wednesday is defined twice, the allowed time for Wednesday is 10:00 to 16:00 and 17:00 to 18:00.

You can specify a maximum of four allowed times per day for a phone attribute.

Note:

The number of allowed times per day of a phone attribute affects the time required for filtering the records.

The default allowed time is 00:00 to 23:59.

POM uses the allowed time information to derive a guard time for phone 1 if the User Preferred Time option is enabled on the Campaign Creation page.

For more information, see Advanced guard time with follow-the-sun dialing.

phonenumber1allowedtime

phoneNumber1AllowedTime

Phone 1 Disallowed Time

Use this attribute to specify specific hours and days of the week during which phone 1 cannot be dialed.

For example, your customer does not want to be called on phone 1 during specific hours and days of the week.

Use the following example format to specify the disallowed time:

0-6.19:00.23:59

Where:

  • 0-6 represent days of the week. Where, 0 represents Sunday and 6 represents Saturday.

  • 19:00 represents the beginning of the disallowed time.

  • 23:59 represents the end of the disallowed time.

Hence, in the preceding example, the disallowed time to dial phone 1 is from Sunday through Saturday from 19:00 to 23.59.

To specify different disallowed times for different days of the week, use a space as a separator.

Example 1:

1-5.18:00.23:59 6.14:00.23:59 0.9:00.23:59

In the preceding example, the disallowed time to dial phone 1 is:

  • Monday through Friday from 18:00 to 23:59.

  • Saturday from 14:00 to 23:59.

  • Sunday from 9:00 to 23:59.

Example 2:

1-5.18:00.23:59 3.9:00.10:00

In the preceding example, the disallowed time to dial phone 1 is:

  • Monday, Tuesday, Thursday, and Friday from 18:00 to 23:59.

  • Because the disallowed time for Wednesday is defined twice, the disallowed time for Wednesday is 9:00 to 10:00 and 18:00 to 23:59.

You can specify a maximum of four disallowed times per day for a phone attribute.

Note:

The number of disallowed times per day of a phone attribute affects the time required for filtering the records.

The default disallowed time is Null.

POM uses the disallowed time information to derive a guard time for phone 1 if the User Preferred Time option is enabled on the Campaign Creation page.

phonenumber1disallowedtime

phoneNumber1DisAllowedTime

Phone 2

The secondary phone number of the contact.

phonenumber2

phoneNumber2

Phone 2 Country Code

The country code associated with the Phone 2 attribute.

phonenumber2ctrycode

phoneNumber2CtryCode

Phone 2 State

The state associated with the Phone 2 attribute.

phonenumber2state

phoneNumber2State

Phone 2 Wireless

Indicates whether the Phone 2 attribute is of a wireless phone.

phonenumber2wireless

phoneNumber2Wireless

Phone 2 Time Zone

The time zone associated with the Phone 2 attribute.

phonenumber2tz

phoneNumber2TimeZone

Phone 2 Allowed Time

Use this attribute to specify specific hours and days of the week during which phone 2 can be dialed.

For more information about the allowed time format, see the description for the Phone 1 Allowed Time attribute.

POM uses the allowed time information to derive a guard time for phone 2 if the User Preferred Time option is enabled on the Campaign Creation page.

phonenumber2allowedtime

phoneNumber2AllowedTime

Phone 2 Disallowed Time

Use this attribute to specify specific hours and days of the week during which phone 2 cannot be dialed.

For more information about the disallowed time format, see the description for the Phone 1 Disallowed Time attribute.

POM uses the disallowed time information to derive a guard time for phone 2 if the User Preferred Time option is enabled on the Campaign Creation page.

phonenumber2disallowedtime

phoneNumber2DisAllowedTime

E-mail

The email address of the contact.

email

email

Language

The default language associated with the contact.

language

language

Country Predefined

The country of residence associated with the contact.

countrypredefined

country

System AgentID

System Attribute that you can use as per your requirement. You can also use this attribute if users face performance issues with any custom attribute for “Get Contact Batch from Contact List API”.

sysAgentId

sysAgentId

Zip Code Predefined

The primary zip code associated with the contact record.

zipcodepredefined

zipcode

Zipcode Time Zone Predefined

Use this attribute to specify the time zone of the primary zip code.

POM uses the time zone information of the zip code to derive a zip code-based guard time for the record if the Timezone of Zipcode option is enabled on the Campaign Creation page.

For more information, see Advanced guard time with follow-the-sun dialing.

zipcodetzpredefined

zipcodeTzPredefined

Zipcode State Predefined

Use this attribute to specify the state of the primary zip code.

POM uses the state of the zip code to derive a zip code-based guard time for the record if the Timezone of Zipcode option is enabled on the Campaign Creation page.

zipcodestatepredefined

zipcodeStatePredefined

Zipcode1 Predefined

Use this attribute to specify the secondary zip code associated with the contact record.

zipcode1predefined

zipcode1Predefined

Zipcode1 Time Zone Predefined

Use this attribute to specify the time zone of the secondary zip code.

POM uses the time zone information of the zip code1 to derive a zip code1-based guard time for the record if the Timezone of Zipcode option is enabled on the Campaign Creation page.

zipcode1tzpredefined

zipcode1TzPredefined

Zipcode 1 State Predefined

Use this attribute to specify the state of the secondary zip code.

POM uses the state of zip code1 to derive a zip code1-based guard time for the record if the Timezone of Zipcode option is enabled on the Campaign Creation page.

zipcode1statepredefined

zipcode1StatePredefined

Note:

Predefined attributes are not mandatory attributes while importing. Only the ID attribute is mandatory. POM internally updates the Last Successful Attempt Time, Last Attempt Time, and Last Completion Code attributes, and these attributes are not visible from the contact browser.

Custom Attributes

You can create and add Custom Attributes to a contact list as required.

To specify the values for the language attribute, refer Supported Input languages for the allowed values.

To specify values for the time zone attributes, refer Supported time zones.

For the list of supported time zones for the Advanced Guard Time feature, see Supported time zone after enabling advanced guard time.

You can limit the access to attributes from specific organizations by marking the attributes as private or public. For example, you can mark the salary attribute as a private attribute and assign it to an organization.

The attributes created by an Org user are associated only with creator's organization. For example, a user Joe belonging to the Sales organization (Sales/Joe) creates a custom attribute CustomerType. This custom attribute is visible only to Sales organization.

A global user can create custom attributes and can mark them as private. The global user can associate such private attributes with one or more organizations. The global administrator can create a private custom attribute salary and give explicit permission to HR, and Finance organization to access this attribute.

Predefined attributes of a contact, such as Phone 1 and Last Name, are global and are accessible to all organization users. The global user has access to all attributes. For an organization user, the private contact attributes associated to the user's organization, and all public attributes, are accessible while creating campaigns, creating campaign strategies, and creating data sources.

Note:

A global user does not belong to any organization, and has the POM Administration and POM Campaign Manager roles. An organization user (Org user) belongs to an organization created in Voice Portal or Avaya Experience Portal, and has the Org POM Campaign Manager role.