API Blog

Communication and Data Quality APIs for real-time business solutions.

Posts Tagged ‘SLA’


CDYNE Launches International Address Verification

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , ,

International-address-verification

Today CDYNE launched PAV-I, an international postal address verification API which validates addresses for over 240 countries. Businesses with an international market presence can ensure data quality for their customer base without any prior knowledge of international address formats or foreign characters. One of the great features of PAV-I is that it takes the guesswork out of the many address formats that exist worldwide. We are excited about this new offering because it complements CDYNE’s existing PAV API, which is CASS Certified™ for US postal addresses, and now verifies Canadian addresses at no additional cost.

TRANSLITERATE ADDRESSES FROM ONE ALPHABET TO ANOTHER

PAV-I supports 9 writing systems and will transliterate address data for Latin, Cyrillic, Greek, Hebrew, Japanese Kanji, Chinese, Arabic, Thai, and Korean Hangul. For example, if you input a Japanese address in English characters, you have the option to request the validated address in either English or Japanese Kanji.

We will use the address 3-24-20, YOKODAI ISOGO-KU YOKOHAMA, 2350045, JAPAN to highlight the transliteration capabilities of PAV-I. The default setting for transliteration is false. When set to true, the verified address will output to the native language if it is supported. The only exception to this is the country output field, which will return in English.

Address entered with native output set to true:

Input Address: 3-24-20 YOKODAI ISOGO-KU YOKOHAMA 2350045 JAPAN

Output Results: A RESCODE of “1″ and OUTPUTSTATUS of “C” combined means the address was successfully matched or parsed and has been corrected to match the reference data. The corrected and transliterated address is output both in the ADDR field as well as the individual address fields. As mentioned earlier, the COUNTRY output field will return in English and does not transliterate.

 

The last output field MATCHLVL returned a “2,” which signifies verification down to the street level. These output returns are meaningful because they provide a record of any corrections that were made to your addresses along with the level to which the addresses were verified. The following MATCHLVL returns are available:

  • 0 – No Match
  • 1 – Town, City, Locality, Municipality, Suburb
  • 2 – Street
  • 3 – Premise (Building)
  • 4 – Organisation (Varies by country, Business or Administrative Entity)

 

Address entered with native output set to false:

Input Address: 3-24-20 YOKODAI ISOGO-KU YOKOHAMA 2350045 JAPAN

Output Results: A RESCODE of “1″ and OUTPUTSTATUS of “C” combined means the address was successfully matched or parsed and has been corrected to match the reference data.

INNOVATIVE PARSING ABILITY

PAV-I has the ability to parse addresses entered in one or many fields. Using multiple address fields for input is useful when you are familiar with international addresses and the specific elements of the input address. If uncertain of the specific address elements, inputting information in the wrong fields may complicate or confuse matching.

To illustrate this, let’s use the address Rose House, 51-59 Circular Road, Isle of Man, IM1 1AZ, United Kingdom to show how this address can be entered using fielded or unfielded input.

Address entered with unfielded input:

Input Address: Rose House, 51-59 Circular Road, Isle of Man, IM1 1AZ, United Kingdom

Output Results: A RESCODE of “1″ and OUTPUTSTATUS of “V” combined means the address was successfully matched or parsed and has been verified mailable with no change.

Address entered with fielded input:

Input Address: Rose House, 51-59 Circular Road, IM1 1AZ, United Kingdom

Output Results: In this case, “Isle of Man” was not included in the input data. As a result, RESCODE  “1″ and OUTPUTSTATUS “C” was returned (the address was successfully matched or parsed and has been corrected to match the reference data).

PAV-I VERIFICATION CODES

Addresses are verified with a RESCODE and an OUTPUTSTATUS. The RESCODE returns data based on whether the address was successfully matched or not. The OUTPUTSTATUS provides extra details regarding the verification or correction that occurred when verifying the address. 

RESCODE
OUTPUT STATUS DETAILS
0   Internal Error Occurred (Contact CDYNE)
1 V Address was successfully matched or parsed and has been verified mailable with no change
1 C Address was successfully matched or parsed and has been corrected to match reference data.
1 P Address was successfully parsed but there is no matching reference data.
2 N There were no hits found and address was not matched or parsed. (This is also returned if an attempt is made to verify an unsupported country.)
3 P Insufficient input details (Too many possible matches)
4   Ambiguous result (Many possible address results)

 

For more information about CDYNE PAV-I API, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE PAV-I API.

Developers find CDYNE PAV-I API integration details on the CDYNE developer’s wiki

 

CDYNE PAV Now Offers Full Canadian Address Verification

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , ,

Canadian Address Verification

CDYNE’s Postal Address Verification API now fully validates Canadian addresses. You can standardize, correct, and verify US and Canadian addresses in one step. The API has been renamed PAV, and is the perfect complement to the PAV-I API, which standardizes and validates international addresses.

There are two supported operations for Canadian address verification: VerifyAddress and VerifyAddressAdvanced. Only two return codes apply to Canadian addresses. A return code of 200 means that the address was verified. A return code of 202 means that the input address is confirmed for all components except for the secondary number. A return code of 10 means that the address could not be found or verified.

If you have Canadian addresses with missing zip codes, PAV can append the zip code of the address as long as the Canadian province name has been abbreviated at input. Please see image below for an example.

We will use the address 75 University Ave West, Waterloo, ON to emphasize PAV’s ability to append a missing zip code.

Address input with missing zip code:

Address output with appended zip code:

 

As you can see, the correct zip code has been added and the address yields a return code of 200, meaning that the address is verified.  The address is now prepared for optimum delivery as suggested by the Canada Post with the output address properly parsed in upper case fonts and the zip code separated after the first three characters.

For more information about CDYNE PAV, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE PAV.

Developers find CDYNE PAV API integration details on the CDYNE developer’s wiki.

Deliver Relevant Communications to Customers and Clients

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , , ,

relevant-communications3

CDYNE Phone Notify! API is an automated API phone notification system that allows IT departments to build voice applications to deliver relevant communications to customers and clients.  It has the ability to send or receive up to 5,000 tier-1 quality phone calls per minute using text to speech (TTS) in multiple languages, recorded files, or both. With over 50 programming methods, you can build powerful applications that will handle complex phone scripts, send immediate or scheduled phone calls, respond to call actions in real time, and manage call lists. Phone Notify! allows programmers to send automated phone alerts, conduct phone surveys, perform conference calls, and integrate custom business applications into their existing system.

AN OVERVIEW

There are over 50 Phone Notify! programming operations available to build and integrate voice applications into your system. They can be categorized into the list shown below. Additionally, a detailed operation list by category may be found here.

  • Send and Receive Phone Calls
  • Status Report Management
  • Script Management
  • Sound File Management
  • List Management

 

TUTORIALS & SCRIPTING SAMPLES

Tutorials 1 and 2 use C# in Visual Studio 2010. You may find additional source code examples and download code examples from the Phone Notify! developer’s wiki. The script samples show advance scripting features that are available with Phone Notify! API.

Build an appointment reminder using NotifyPhoneBasic and RecordSoundViaPhoneCall methods

Integrate conference calls using NotifyPhoneAdvanced, SetIncomingCallScript, and CancelConference methods

An advanced scripting example for automated phone reminders

Additional scripting examples for a political poll, school announcement, registration confirmation, survey, and recording sound files may be found on the CDYNE developer’s wiki.

For more information about CDYNE Phone Notify! API, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Phone Notify! API.

Developers find CDYNE Phone Notify! API integration details on the CDYNE developer’s wiki.

Phone Notify! Programming Methods

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , , ,

programming-methods3

With over 50 programming methods, you can build powerful applications with Phone Notify! that will handle complex phone scripts, send immediate or scheduled phone calls, respond to call actions in real time, and manage call lists. Phone Notify! allows programmers to send automated phone alerts, conduct phone surveys, perform conference calls, and integrate custom business applications into their existing system.

The following list shows Phone Notify! operations by category. You may view each method’s parameters, data type, and sample input and output data on the Phone Notify! developer’s wiki . A compiled list of operation notes may also be found in the Phone Notify! Specification PDF.

Send and Receive Phone Calls

Basic Methods for Single or Multiple Calls

NotifyPhoneBasic
This method will call any phone number in the US/Canada and read the TextToSay to that phone number.

NotifyPhoneBasicWithTryCount
Same as NotifyPhoneBasic with a number of times it will retry the call. The max is 3.

NotifyPhoneBasicWithTransfer
This method will call any phone number in the US/Canada and read the TextToSay to that phone number. It also allows you to transfer a call by pressing 0.

NotifyPhoneEnglishBasic
This method will call any phone number in the US/Canada and read the TextToSay to that phone number using the voice of Diane (VoiceID: 0). PhoneNumberToDial must be filled in (They can be in any format as long as there is 10 digits).

NotifyMultiplePhoneBasic
This method will call phone numbers with a default of 3,000 calls per minute (delimited by a semicolon) in the US/Canada and read the TextToSay to that phone number.

NotifyMultiplePhoneBasicWithCPM
This method includes a way to set the calls per minute (CPM) when calling phone numbers in the US/Canada, and will read the TextToSay to that phone number.

Advanced Methods for Single or Multiple Calls

NotifyPhoneAdvanced
Allows you to control notifies with a class. This method allows for the maximum combinations of using Phone Notify! API.

NotifyMultiplePhoneAdvanced
Allows you to control notifies with a class. This function allows multiple notifies to be sent at one time. This allows for the maximum combinations of using Phone Notify! API. We suggest using our list management features for batches over 100.

Additional Methods

CancelNotify
Cancels a single notify. This will not cancel completed calls or calls in progress. You will receive credit for any successfully cancelled notify that returns “true.”

getVoices
This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods

GetIncomingCallScript
Allows you to get the call script for incoming calls for a particular number. You must have incoming phone numbers set by CDYNE Staff.

CancelConference
Cancels a conference by conference key.

Status Report Management

GetQueueIDStatus
Returns a status on a particular QueueID.

GetQueueIDStatusWithAdvancedInfo
Returns a status on a particular QueueID. This also includes variable information and more.

GetQueueIDStatusesByPhoneNumber
Returns the last 10 phone notifications for a particular phone number.

GetMultipleQueueIdStatus
This method returns information about the status of multiple notifies via QueueID (delimited by a semicolon). The QueueID returns a specific phone call ID.

GetResponseCodes
This method will list all of the response codes.

Script Management

ScriptDelete
Script Management – Delete a script.

ScriptList
Script Management – Lists the scripts belonging to a license key. Set IncludeGlobalScripts to true if you would like CDYNE global scripts to be included.

ScriptLoad
Script Management – Load a script’s text.

ScriptSave
Script Management – Save a script (Scriptname can only be 50 characters or less). Saving a script with an existing name will overwrite the old script.

SetIncomingCallScript
Allows you to update a Call Script for incoming calls. You must have incoming phone numbers set by CDYNE Staff.

Sound File Management

UploadSoundFile
Sound file upload. Our system accepts WAV (PCM, U-law, A-law, MS ADPCM) Files. To use the sound file in the notify put ~ around it and start it with a ^.Example “Hello ~^soundfile~, you are cool.”(This would TextToSay “Hello,” and “you are cool,” adding the sound file in the middle).

GetSoundFile
Sound file retrieval.

GetSoundFileInMP3
Sound file retrieval (returns an MP3 encoded in 32,64, or 128).

GetSoundFileInUlaw
Sound file retrieval (returns ULAW encoded file).

GetSoundFileLength
Gets a sound file length in seconds.

GetSoundFileURL
Sound file retrieval. Returns a URL to listen to a particular sound file in MP3.

GetTTSInMP3
Allows you to convert text into a MP3 encoded sound file. Returns an MP3 encoded in 32,64, or 128 (May require a additional License Key).

GetTTSInULAW
Allows you to convert text into a ULAW encoded sound file (May require an additional License Key).

RecordSoundViaPhoneCall
Request the system to call you to record a sound file. SoundfileIDs can only be lowercase and contain normal file characters. The CallerIDName will be the SoundFileID and the number will be 8000000000.

RemoveSoundFile
Sound file delete.

RenameSoundFile
Sound file rename.

ReturnSoundFileIDs
Get available sound files that you can add to your stream via a license key.

List Management

LM_AddListMember
List Management – Allows you to add contacts to a List. You will need the ListID. The only required fields are ListID, PhoneNumber, and LicenseKey. Returns a List Member ID.

LM_AddNewList
List Management – Allows you to add a list that can contain members (Contacts). You can also attach this list to be apart of a Parent List, otherwise leave ParentList ID = 0.

LM_AlterListID
List Management – Allows you alter a ListMember, use 0 if you do not want to have a ParentListID, and -1 if you do not wish to change the ParentListID.

LM_AlterListMember
List Management – Allows you alter a ListMember.

LM_DeleteList
List Management – Deletes a List and its sub-lists (The lists that have is as a ParentListID).

LM_DeleteListMember
List Management – Deletes a List’s Member (or contact).

LM_DialList
List Management – Dial a List by ListID. Returns a Batch ID for the list and begins dialing at the scheduled time. Scheduled times are in UTC.

LM_DialListAdvanced
List Management – Dial a list by ListID that allows you to set more advanced properties.

LM_GetListIDsByLicensekey
List Management – Obtains all list IDs from a specific License key.

LM_GetListMembersByListID
List Management – Gets all the phone numbers with their first and last names.

For more information about CDYNE Phone Notify! API, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Phone Notify! API.

Developers find CDYNE Phone Notify! API integration details on the CDYNE developer’s wiki.

Building an Appointment Reminder with CDYNE Phone Notify! Web Service

Posted by: CDYNE  /  Tags: , , , , , , , , , , , ,

appt-reminder

Phone Notify! Web Service supports 50 operations to build customizable and scalable voice applications. It’s designed to enable any business application to send or receive up to 5,000 tier-1 quality phone calls per minute using text to speech, recorded files, or both. This article will take a look at 2 operations to build a basic voice application that will use text to speech and a recorded sound file to send out an appointment reminder.

This tutorial uses  C# in Visual Studio 2010. You can find additional source code examples and download code examples from the Phone Notify! developer’s wiki.

Phone Notify! Operations Used 

 Step 1: Consuming Phone Notify! Web Service 

  • Open a new or existing project in Visual Studio 2010
  • From the top tool bar, go to Project>Add Service Reference, which will open up the following screen:

  • Click on the Advanced button in the lower left-hand corner, which will open up another screen:

  • Click on the Add Web Reference button, which will open up a third screen:

  • Add the Phone Notify WSDL URL: http://ws.cdyne.com/NotifyWS/PhoneNotify.asmx?wsdl to the URL box, and click on the green arrow. This will pull up the Phone Notify! Web Service Description as shown in the next screen:
  • Name the web reference. In this case, we named it WSDL. Then click the Add Reference button.

Step 2: Setting Up a Basic Notify

The example below shows the code used to send a Basic Notify using the NotifyPhoneBasic method.

A few notes about using the NotifyPhoneBasic method:

  • This method will call any phone number in the US/Canada and read the TextToSay to that phone number
  • PhoneNumberToDial and CallerID must be filled in (they can be in any format as long as there is 10 digits)

When the program below is run with a license key, CDYNE Corporation will call 3215554757 with a text to speech message stating, “John Williams has an appointment with Dr. Smith on Tuesday, May 13 at 3pm.” The strings written in red in the screenshot is made up of the following components:

  • Phone number to dial – “3215554757″
  • Script “John Williams has an appointment with Dr. Smith on Tuesday, May 13 at 3pm.”
  • Caller ID - “7575449510″
  • Caller ID Name - “CDYNE Corporation.”
  • Voice ID - “4″
  • License Key – this is required to send or receive phone calls with Phone Notify! Web Service.

This notify uses voice ID 4, named Callie, and represents a US English female voice, age 30.You can invoke all voices available with Phone Notify! with the getVoices method. You may also listen to the voices at http://cepstral.com/demos/. Please note that the Cepstral website may contain voices not currently available with the Phone Notify! Web Service.

WSDL.PhoneNotify pn = new WSDL.PhoneNotify();

            WSDL.NotifyReturn nr = pn.NotifyPhoneBasic(“3215554757″,

            “John Williams has an appointment with Dr. Smith on Tuesday, May 13 at 3pm.”,

           ”17575449510″, “CDYNE Corporation”, “4″, “LicenseKey”);

Step 3: Request a Phone Call to Record a Sound File

One way to make automated phone reminders more personal is to use a recorded voice. Although text to speech can be very useful in some applications, it is a mechanical and impersonal sounding messaging tool for some customer interactions. In this step, we will use the RecordSoundViaPhoneCall method to call a designated phone number and record a sound file. The sound file recording states, “has an appointment with Dr. Smith on,” and leaves out the customer’s name, and the date and time of the appointment. These three values will remain as text to speech when we put the script together in Step 4.

A few notes about the RecordSoundViaPhoneCall method:

  • SoundfileIDs can only be lowercase and contain normal file characters
  • The CallerIDName will be the SoundFileID
  • The CallerID will be an 800 or 866 number

When this program is run with a license key, the phone number designated in the code (3215554757) will receive a phone call with instructions to record sound file “smith1.” Once recorded, the file will play back and the user has the option to accept or rerecord the message. We’ll access this file in the next step.

WSDL.PhoneNotify pn = new WSDL.PhoneNotify();

            WSDL.RecordSoundViaPhoneCall(“3215554757″, “smith1″, “LicenseKey”);

Step 4: Putting Together the Script

In the final step, we’ll use the NotifyPhoneBasic method to combine the text to speech and recorded file, which we named smith1.

When the program below is run with a license key, CDYNE Corporation will call 3215554757 with a recorded message combined with text to speech variables. The variables include, “John Williams” and “Tuesday, May 13 at 3pm.”

WSDL.PhoneNotify pn = new WSDL.PhoneNotify();

            WSDL.NotifyReturn nr = WSDL.NotifyPhoneBasic(“3215554757″,

            “John Williams ~^smith1~ Tuesday, May 13 at 3pm.”,

            “17575449510″, “CDYNE Corporation”, “4″, ” LicenseKey”);

For more information about CDYNE Phone Notify! API, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Phone Notify! API.

Developers find CDYNE Phone Notify! API integration details on the CDYNE developer’s wiki.

Part 5: CDYNE Postal Address Verification DPV Code Suggestions

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , , ,

pav-5

CDYNE Postal Address Verification API returns USPS mailing industry information that can be useful for interacting with address verification at point of entry. In the chart below, the first two columns outline the values returned when using the VerifyAddressAdvanced method.

For example, inputting the address “2125 smith ave, chesapeake, va” will return the following mailing industry values:

  • DpvConfirmationIndicator: D
  • DpvFootnote1: AA
  • DpvFootnote2: N1

 

Comparing D AA N1 to the chart below may prompt a suggested interaction of, “Verify secondary information, it is not present.” In other words, the suite number is missing. Depending on the data entry scenario, you can generate an error pop-up to ask for the secondary address information, or flag the address for future processing or validation.

DPV Return Code

 

Footnote

 

Suggested Interaction

 


N


AA


Verify the address
. The address validated on the CASS certified software engine but cannot be validated in the DPV process.


N


AA M1

 
Verify the Primary Number, it is not present. The address validated on the CASS certified software engine, but cannot be validated in the DPV process


N


AA M3


Verify the Primary Number
, It is present but not valid. The address validated on the CASS certified software engine, but cannot be validated in the DPV process.


N


AA P1


Verify the box number
, it is not present for this RR or HC address but needed to confirm in the DPV process.


N


AA P3


Verify the box number
, it is present for this PO Box, RR or HC address but cannot be confirmed in the DPV process.


Y


AA BB


No action needed
, the address validated to all components.


Y


AA RR


No action needed
, the address validated. It has been found in the CMRA table with PMB information present.


Y


AA R1


The address validated
. It has been found in the CMRA table without PMB information.


Y


AA F1


No action needed.


Y


AA G1


No action needed.


Y


AA U1


No action needed.


S


AA CC


Verify secondary information
, it is present but cannot be confirmed in the DPV process.


S


AA P3


Verify the box number
, it is present for this PO Box, RR or HC address but cannot be confirmed in the DPV process.


S


AA CC RR


Verify secondary information
, it is present but cannot be confirmed in the DPV process. It has been found in the CMRA table with PMB info present.


S


AA CC R1


Verify secondary information
, it is present but cannot be confirmed in the DPV process. It has been found in the CMRA table without PMB information and is not required for USPS delivery.


D


AA P1


Verify the box number
, it is not present for this RR or HC address but needed to confirm in the DPV process.


D


AA N1


Verify secondary information
, it is not present.


D


AA N1 RR


Verify secondary information
, it is not present. It has been found in the CMRA table with PMB information present.


D


AA N1 R1


Verify secondary information
, it has been found in the CMRA table without PMB information and is not required for USPS delivery.


Blank


A1 M1


Get correct address
, this address cannot be found in CASS certified software engine so it is not presented to the DPV process.


Blank


A1 M3


Get correct address
, this address cannot be found in CASS certified software engine so it is not presented to the DPV process.


Blank


A1


Get correct address
, this address cannot be found in CASS certified software engine so it is not presented to the DPV process.



You can read the rest of the blog series by accessing the links below:

Part 1: CDYNE Postal Address Verification API Overview

Part 2: CDYNE Postal Address Verification API Operations Overview

Part 3: CDYNE Postal Address Verification VerifyAddress Operation

Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation

 
 

For more information about CDYNE Postal Address Verification, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Postal Address Verification.

 

Part 3: CDYNE Postal Address Verification VerifyAddress Operation

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , , ,

pav-3-header

CDYNE Postal Address Verification VerifyAddress programming method is the barebones Web Service call for users who only need to validate whether or not an address is deliverable. The address deliverability status is returned through the DPV Return Code system, which indicates the parts of the address that are incorrect, and will return corrected information on file with the USPS. This article will take you through three address input and output examples to display some of the important features that the VerifyAddress operation offers.

Example 1: A Correct Address is Confirmed Deliverable

Let’s begin with a correct address and run it through the VerifyAddress Operation. The left hand column shows the input address and the license key. The right hand column displays the corrected address and return code that is sent back by CDYNE Postal Address Verification. There are several differences that immediately jump out between the input and output columns:

  • Lowercase letters were changed to all caps
  • The secondary address line input value of 200 was appended to the primary address line in the output as “STE 200″
  • The zip + 4 value of “23320-2518″ was appended
  • A code of “100″ was returned

 


VerifyAddress Input


VerifyAddress Output


Firm: Cdyne

Primary Address Line: 2125 smith ave

Secondary Address Line: 200

City: chesapeake

State: va

Zip: 23320


Firm: CDYNE

Primary Address Line: 2125 SMITH AVE STE 200

Secondary Address Line: 200

City: CHESAPEAKE

State: VA

Zip: 23320-2518


Additional Input


Additional Output


License Key: F01d55fd-5155-5455-5585-e84ab8de5555


Return Code: 100

Although the USPS does not require all capital letters the USPS prefers all caps or uppercase for ease of automatic scanning and application of bar codes. With the VerifyAddress method, address data is returned in all caps. You can use VerifyAddressAdvanced operation to return addresses in proper case.

The USPS preferred location of the secondary address unit designators (i.e. APT, STE, BLDG) is at the end of the delivery address line. In the example above, CDYNE Postal Address Verification correctly moved “200″ to the end of the primary address line, and appended the correct designator of “STE.”

The zip + 4 determines a more precise location than the five-digit zip code alone. The zip + 4 includes the five-digit zip code, a hyphen, and four-digits at the end (i.e. 23320-2518).

The return code of 100 means all parts of the address are confirmed as deliverable. DPV is a USPS validation process that confirms the existence of a specific address (down to the apartment or suite number) and whether or not it is a valid destination for a mailing or package.

CDYNE Postal Address Verification DPV Return Codes:

  • 10 – Input address is not found
  • 100 – Input address is DPV confirmed for all components
  • 101 – Input address is found, but not DPV confirmed
  • 102 – Input address primary number is DPV confirmed – Secondary number is present but not DPV confirmed
  • 103 – Input address primary number is DPV confirmed – Secondary number is missing
  • 200 – Canadian address on input. Verified on city level only

 

Example 2: Providing Minimal Input Field Information

The minimum address field requirements for CDYNE Postal Address verification to validate an address are one of two combinations:

  • Primary address line/city/state
  • Primary address line/zip code

In the example below, entering the primary address line, city, and state returns a standardized and corrected address, but the return code in this instance is 103. This means the input address primary number is DPV confirmed, and the secondary number is missing. In other words, there is supposed to be a suite or apartment number, but that information cannot be determined with the input data. This is an opportunity to interact with the data entry in real time, or flag the address in the database for further evaluation.


VerifyAddress Input


VerifyAddress Output


Firm:

Primary Address Line: 2125 smith ave

Secondary Address Line:

City: chesapeake

State: va

Zip:


Firm:

Primary Address Line: 2125 SMITH AVE

Secondary Address Line:

City: CHESAPEAKE

State: VA

Zip: 23320-2518


Additional Input


Additional Output


License Key: F01d55fd-5155-5455-5585-e84ab8de5555


Return Code: 103

In the second example, entering the primary address line and zip code also returns a standardized and corrected address with a return code of 103.


VerifyAddress Input


VerifyAddress Output


Firm:

Primary Address Line: 2125 smith ave

Secondary Address Line:

City:

State:

Zip: 23320


Firm:

Primary Address Line: 2125 SMITH AVE

Secondary Address Line:

City: CHESAPEAKE

State: VA

Zip: 23320-2518


Additional Input


Additional Output


License Key: F01d55fd-5155-5455-5585-e84ab8de5555


Return Code: 103

 

Example 3: Utilizing the Firm Name or Recipient Input Field

CDYNE Postal Address Verification utilizes the USPS SuiteLink database to provide improved business addressing information by appending known secondary (suite) information to business addresses. In the example below, CDYNE Postal Address Verification appended “STE 200″ to the original address because it matched the firm name, “CDYNE” to “STE 200″ in the USPS database. Notice that the input address does not contain a secondary or suite number, but the corrected address does.


VerifyAddress Input


VerifyAddress Output


Firm: CDYNE

Primary Address Line: 2125 smith ave

Secondary Address Line:

City: Chesapeake

State: VA

Zip:


Firm: CDYNE

Primary Address Line: 2125 SMITH AVE STE 200

Secondary Address Line:

City: CHESAPEAKE

State: VA

Zip: 23320-2518


Additional Input


Additional Output


License Key: F01d55fd-5155-5455-5585-e84ab8de5555


Return Code: 100

 

You can read the rest of the blog series by accessing the links below:

Part 1: CDYNE Postal Address Verification API Overview

Part 2: CDYNE Postal Address Verification API Operations Overview

Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation

Part 5: CDYNE Postal Address Verification DPV Code Suggestions

For more information about CDYNE Postal Address Verification, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Postal Address Verification.

Part 2: CDYNE Postal Address Verification API Operations Overview

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , ,

pav-blog-2

CDYNE Postal Address Verification API offers nine programming operations that deliver address data verification and data returns in a variety of ways. Each operation specializes in a specific set of data returns so businesses can select only the address information they need from a wider range of options. The following is a summary of each operation with an example of how each one can be used.

VerifyAddress Operation

This programming operation is the barebones Web Service call for users who only need to validate whether or not an address is deliverable.  Address deliverability status is returned through the DPV Return Code system, which indicates the parts of the address that are incorrect, and will return corrected information on file with the USPS. In the example below, the left column shows the address sent to CDYNE Postal Address Verification (along with the required license key). The right column shows the corrected address. It has been standardized in all caps, the suite designator has been corrected to “STE,” and the zip+4 number “2518″ has been appended to the five-digit zip code. Most importantly, CDYNE Postal Address Verification returns the code 100. This means all parts of the address are confirmed as deliverable (see DPV Return Codes below the example).  DPV is a USPS validation process that confirms the existence of a specific address (down to the apartment or suite number) and whether or not it is a valid destination for a mailing or package.

Additionally, CDYNE Postal Address Verification will return the county, country, and return code data. The return code designates the status of the Delivery Point Validation (DPV) information on file with the USPS.

CDYNE Postal Address Verification DPV Return Codes:

  • 10 – Input address is not found
  • 100 – Input address is DPV confirmed for all components
  • 101 – Input address is found, but not DPV confirmed
  • 102 – Input address primary number is DPV confirmed – Secondary number is present but not DPV confirmed
  • 103 – Input address primary number is DPV confirmed – Secondary number is missing
  • 200 – Canadian address on input. Verified on city level only

To see examples of addresses with return codes, see Part 3: CDYNE Postal Address Verification VerifyAddress Operation.

VerifyAddressAdvanced Operation

In addition to validating whether an address is deliverable, this programming operation returns a host of optional information at no extra charge including geolocation, legislative, census, and mailing industry information. These options can be turned on with a true value within the web service call (the default value is set to false). In the example below, census, geo location, legislative, mailing industry, and residential delivery indicators were set to true. The advantage of the VerifyAddressAdvanced Operation is the ability to customize the data return according to your business needs.

The example above does not show all of the data available for return. Please see Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation which details the complete features and capabilities of this programming method.

GetIntelligentMailBarcode

CDYNE Postal Address Verification API can be used to obtain an Intelligent Mail Barcode string to generate a barcode for mail discounts. The first step is to run an address through the VerifyAddressAdvanced operation, which will return the Intelligent Mail Barcode Key as shown in the example below.

Once the Intelligent Mail Barcode Key is obtained, the second step is to run the GetIntelligentMailBarcode operation. There are six required input values, and they are defined as the following:

  • Barcode Identifier — a two-digit number assigned by the USPS to encode the presort identification
  • Service Type Identifier — a three-digit number assigned by the USPS for any combination of services requested on the mailpiece
  • Mailer Identifier — a unique six or nine-digit number assigned by the USPS that identifies a business entity
  • Serial Number — a six or nine-digit number assigned by the mailer for uniquely identifying and tracking mailpieces
  • Intelligent Mail Barcode Key — the data string returned by CDYNE Postal Address Verification VerifyAddressAdvanced operation
  • License Key — a unique data string assigned by CDYNE Corporation to run Postal Address Verification transactions

The string data in the Intelligent Mail Barcode return can be used to generate barcodes for postal mailing discounts.

CDYNE Postal Address Verification GetIntelligentMailBarcode Return Codes:

  • 0 – Success
  • 1 – Invalid input

 

GetZipCodesWithinDistance

This operation returns all zip codes within the radius of a designated latitude and longitude. In the example below, the latitude/longitude and a radius of 1 mile returns five zip codes for that geolocation. The GetZipCodesWithinDistance operation also includes a return code of “0″ which means “success.” The return codes for the GetZipCodesWithinDistance operation are listed below.

CDYNE Postal Address Verification GetZipCodesWithinDistance Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – Returned zero zip codes
  • 4 – Outside of the latitude and longitude range

 

GetZipCodesForCityAndState

The GetZipCodesForCityAndState programming operation returns all zip codes associated with the city name and state provided at input. The example below returns nine zip codes for Chesapeake, VA, with a return code of “0″ or successful. The return codes for the GetZipCodesForCityAndState operation are listed below.

CDYNE Postal Address Verification GetZipCodesForCityAndState Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match

 

GetZipCodesForFips

Federal Information Processing Standard or FIPS are standards developed by the U.S. government for use in computer systems by all non-military government agencies and government contractors. The U.S. Census Bureau uses FIPS codes to identify legal and statistical entities including states and counties. By inputting the FIPS code value, you can obtain the associated zip codes as shown in the example below.

If you do not have the FIPS value, one way to obtain is through the VerifyAddressAdvanced method. Here is an example:

 

CDYNE Postal Address Verification GetZipCodesForFips Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – Returned zero zip codes

 

GetCongressionalDistrictByZip

This operation returns the congressional district associated with the zip code provided at input.

CDYNE Postal Address Verification GetCongressionalDistrictByZip Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match
  • 4 – Multiple match

 

GetCityNamesForZipCode

Cities in a zip code may be referred to by more than one name or spelling. The GetCityNamesForZipCode operation returns the actual city name as well as acceptable alternatives. In the example below, the default city name is “Boynton Beach” and an alternate name is “Village of Golf.” Both city names are acceptable city names on file with the USPS.

CDYNE Postal Address Verification GetCityNamesForZipCode Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match

 

GetUrbanizationListForZipCode

Urbanizations are commonly used in Puerto Rico urban areas and they denote an area, sector, or residential development within a geographic area. They are important designators because identical street names and address number ranges can be found within the same zip code. In the following example, the urbanization name is the only element that identifies the location of a particular address.

MR OSIRIS GONZÁLEZ
URB ROYAL OAKS
123 CALLE 1
BAYAMÓN PR 00961-0123

MR PEDRO RIVERA
URB HERMOSILLO
123 CALLE 1
BAYAMÓN PR 00961-1212



CDYNE’s GetUrbanizationListForZipCode programming method will return the urbanization list for the zip code input. In the following example, the zip code, “00965″ returns five urbanization names. Urbanizations typically use the abbreviation URB, but there are exceptions as shown in the example below. BDA (Barriada), BO (Barrio), and VILLA (Villa) are the correct abbreviations to use. The USPS published a detailed addressing standards document for Puerto Rico and US Virgin Islands, which can be found here.

CDYNE Postal Address Verification GetUrbanizationListForZipCode Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match

 

You can read the rest of the blog series by accessing the links below:

Part 1: CDYNE Postal Address Verification API Overview

Part 3: CDYNE Postal Address Verification VerifyAddress Operation

Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation

Part 5: CDYNE Postal Address Verification DPV Code Suggestions

For more information about CDYNE Postal Address Verification, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Postal Address Verification.

Part 1: CDYNE Postal Address Verification API Overview

Posted by: CDYNE  /  Tags: , , , , , , , , , , , , , , , ,

CDYNE Postal Address Verification API

CDYNE Postal Address Verification is a CASS Certified API that checks U.S. addresses against a continuously updated USPS® database to standardize, correct, and validate addresses in one step. It will reduce non-deliverable addresses, ensure the fastest delivery possible, and qualify your mailings for USPS discounts.

An API, or Application Programming Interface, acts as the interface between business web applications, programs, or databases and the CDYNE Postal Address Verification process. The advantage of using a Web Service API is the ability to add advanced features into your business applications without maintaining the software or hardware required to run that feature. CDYNE Postal Address Verification API enables a business IT department to implement address verification capabilities within their existing systems with a minimal time and money investment.

CDYNE Postal Address Verification API is CASS Certified for the most recent Cycle N by the USPS®, which means our software passed the stringent evaluation and testing process the USPS requires for correction accuracy in the areas listed below. As part of the CDYNE Postal Address Verification offering, the following data is included in the pricing.

DPV® (Delivery Point Validation)

DPV is a USPS address validation process that confirms the existence of a specific address (down to the apartment or suite number) and whether or not it is a valid destination for a mailing or package. With CDYNE Postal Address Verification API, DPV is indicated by the return code. The example below shows a return code of 100, which means all parts of the address have been DPV confirmed. In other words, the address is verified as deliverable.

The example below also shows other features included with CDYNE Postal Address Verification. Notice how the input address is standardized in all caps (per USPS formatting guidelines), corrected (“Suite” is changed to “STE” and the 4-digit zip “2518″ is appended to the original zip code provided), and validated for deliverability with a return code of 100.

CDYNE Postal Address Verification returns the following result codes for DPV with the VerifyAddress operation. This is the barebones operation for users who only need to validate whether or not an address is deliverable. For more detailed DPV return codes and suggested interactions, use the VerifyAddressAdvanced Operation, which is discussed in detail in Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation.

  • 10 – Input address is not found
  • 100 – Input address is DPV confirmed for all components
  • 101 – Input address is found, but not DPV confirmed
  • 102 – Input address primary number is DPV confirmed – Secondary number is present but not DPV confirmed
  • 103 – Input address primary number is DPV confirmed – Secondary number is missing
  • 200 – Canadian address on input. Verified on city level only

 

LACSLink®

LACSLink® is a system that matches addresses against a list of rural route, highway route, and box number addresses that have been renumbered or renamed due to 911 address conversions. These conversions involve changing rural-style addresses to city-style addresses for 911 emergency system implementations. LACS stands for Locatable Address Conversion Service. The greatest advantage of LACSLink processing is that it reduces undeliverable mail and ensures that your lists have the most current address information on file, which lowers costs and provides faster delivery. The example below is a made-up address to illustrate how CDYNE Postal Address Verification handles LACSLink return data.

There are three LACSLink code fields that include the LACS Flag, LACS Indicator, and LACS Return Code. CDYNE Postal Address Verification returns the following result codes.

LACS Flag – this indicates whether or not there is an address match with the LACSLink database.

  • Y – LACS record match – the input address matched to a record in the master file, and a new address could be provided.
  • S – LACS record/secondary number dropped – the input address matched to a record in the master file, but the input address had a secondary number and the master record file did not.
  • N – No match – the input address could not be matched to a record in the master file, and a new address could not be provided.
  • F – False positive – a false positive record was detected

 

LACS Indicator – this indicates whether or not the input address has a conversion in the USPS LACSLink database.

  • L – There is a conversion address in the LACSLink database
  • Blank – No conversion address was found
  • 

LACS Return Code – this indicates the reason for the LACS Indicator returned (“L” or “blank”).

  • A – Match – Address Provided – there is a LACSLink record match and a converted address is provided
  • 00 – No Match – there is no match and no converted address
  • 14 – Match – No Conversion – found LACSLink record, but could not convert the data to a deliverable address
  • 92 – Match – Dropped Secondary Number – LACSLink record matched after dropping the secondary number from input address

 

RDI™ (Residential Delivery Indicator)

RDI or Residential Delivery Indicator identifies whether an address is classified as residential or business. Most shipping companies charge a higher price for residential deliveries. Businesses can use RDI data to maximize savings by flagging residential addresses and then shopping for the most cost-effective delivery option. In the following example, the Residential Delivery Indicator is “N,” which indicates that the address is classified as a business (rather than residential) by the USPS.

CDYNE Postal Address Verification returns the following result codes for Residential Delivery Indicator:

  • Y – Address is residential
  • N – Address is commercial

 

SuiteLink™

USPS SuiteLink data provides improved business addressing information by appending known secondary (suite) information to business addresses. In the example below, CDYNE Postal Address Verification appended “STE 200″ to the original address because it matched the firm name, “CDYNE” to “STE 200″ in the USPS database. Notice that the input address does not contain a secondary or suite number, but the corrected address does.

 

CDYNE Postal Address Verification returns the following Suite Link Return Codes:

  • A – SuiteLink Match
  • 00 – No Match – SuiteLink look up was attempted, but a match was not made
  • Blank – SuiteLink lookup was not performed

 

eLOT®

Enhanced Line of Travel or eLOT was developed by the USPS to give mailers the ability to sort their mailings in approximate carrier-casing sequence. eLOT codes organize the delivery points within a zip+4 code in the order that the carrier travels as they deliver mail. Mailers may use eLOT processing to qualify for enhanced carrier route presort discounts.

The eLOT Sequence Number aids in mail sorting, and the USPS defines it as the first occurrence of delivery made to the add-on range within the carrier route. The eLOT Ascending/Descending Code indicates the approximate delivery order within the sequence number.

Barcoding Processing

POSTNET™ – or Postal Numeric Encoding Technique was developed by the USPS to encode zip code information to improve speed, accuracy, and delivery of mail. It allows for rapid and reliable sorting by barcode sorters and provides additional automation discounts for bulk mailings. CDYNE Postal Address Verification returns a POSTNET Barcode string that can be used to generate a barcode image.

The string data in the POSTNET Barcode return consists of the following data, which can be used to generate a barcode for postal mailing discounts.

  • Start character (“f”)
  • Nine digit zip code data (“23320 2518″)
  • Delivery point data (“50″)
  • Check digit (“9″)
  • Stop character (“f”)

 

IM™ Barcode – The Intelligent Mail barcode is the next generation of USPS barcode technology used to sort and track letters and flats. It combines the capabilities of the POSTNET™ barcode and the PLANET Code® barcode into one unique barcode. Bulk mail that is barcoded is eligible for additional USPS discounts. To qualify for these discounts, the USPS requires an accurate Zip + 4 code, which can be matched with CASS Certified software.

CDYNE Postal Address Verification returns a key that can be used to obtain the Intelligent Mail Barcode string to generate a barcode image. Read more details about this in the GetIntelligentMailBarcode section of Part 2: CDYNE Postal Address Verification API Operations Overview .

In this five-part blog series, we will take a more in-depth look at the programming operations that CDYNE Postal Address Verification API will perform as well as how to use the operations and understand the data returns. Click on the links below to read each article.

Part 2: CDYNE Postal Address Verification API Operations Overview

Part 3: CDYNE Postal Address Verification VerifyAddress Operation

Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation

Part 5: CDYNE Postal Address Verification DPV Code Suggestions

For more information about CDYNE Postal Address Verification, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Postal Address Verification.

CDYNE Phone Notify! Account Reporting Features

Posted by: CDYNE  /  Tags: , , , , , , , , , , , ,

phonereports

CDYNE Corporation offers helpful account reporting features for Phone Notify! API, a two way voice API that sends and receives text to speech phone messages. Reporting features include the date, number of calls, answered status, whether or not voicmail or a fax picked up, as well as transfers. All reports can be exported to an .xls or.csv file. It is simple to access the reports by following these steps.

1. Log into your account online at http://www.cdyne.com/ in the upper-right hand corner.

2. Once logged in, select “Manage Services” on the left-hand gray menu.

3. After selecting Manage Services, you will navigate to a page listing your active and inactive Web Services. Active Web Services will be listed on the top of the page.

4. Select an active service to open up the details.

5. Let’s look at Phone Notify! reporting features. There are two reports available, and they include a usage report and a DID report. Select “Report” to access the usage report.

6. The license key must have transactions or usage in order to run this report. You can customize the date range to suit your search needs. The Phone Notify! Report includes the date and number of calls sent, whether or not the call was answered, if a machine, voicemail, or fax picked up the call, and whether or not the call was transferred. Each report can be refreshed and viewed, as well as exported to an .xls or .csv file.

7. Select “DID” to access a list of phone numbers assigned to your Phone Notify! license key. This report will also show any associated PostBackURLs, and allow you to edit those URLS.

Test CDYNE Phone Notify! API for free.

For more information about CDYNE SMS APIs, please call 1-800-984-3710, inquire or initiate a chat.

Page 1 of 2 12