Follow CDYNE Blog on WordPress.com
Header Image -

Tag Archives

27 Articles

CDYNE Phone Notify! API StatusChangePostURL

One of the great features of CDYNE Phone Notify! API is the ability to customize call logic exactly the way your business needs it. It handles complex call scripts, responds to call actions in real time, and can be programmed to deliver relevant communications exclusive to your customers or clients. For many Phone Notify! applications, it is important to know when a call is placed, the call status has changed, the call is finished, or when a call is received. The best way to automate this process is to use the StatusChangePostURL command. With a StatusChangePostURL in place, Phone Notify! will post phone call information to a URL you designate.

What information does the StatusChangePostURL command post?

Phone Notify! utilizes a command called StatusChangePostURL, which will post back information about the phone call to your server. Once you’ve created a web page to handle postbacks, the URL can be set to recieve this information automatically. The following values are posted:

  • QueueID – Contains the ID of the Call
  • ResponseCode – 1 = Call Answered, 2 or more – Call Unanswered (see all status codes here)
  • StartTime – Start time in Universal Time (UTC)
  • EndTime – End time in Universal Time (UTC)
  • Duration – Call Length in Seconds
  • machinedetection – Currently only HUMAN, MACHINE, or FAX
  • AC – Contains a status code – this is for advanced problem solving with Tech Support
  • digitsdialed – contains all the digits dialed during a call
  • incoming – contains true if the call was an incoming call
  • [Any Variables you collected] – any additional variables that you collected during the call

 

Where do I assign the StatusChangePostURL?

There are three scenarios for assigning the StatusChangePostURL command. The first is when using the Advanced methods of Phone Notify! API. You can pass it in the NotifyPhoneAdvanced and NotifyMultiplePhoneAdvanced programming operations. Each operation contains a parameter named, “StatusChangePostURL” where the URL can be input. A URL must be in lower case.

The Basic methods of Phone Notify! do not contain the “StatusChangePostURL” parameter, so an alternative is to assign the URL in the script. In this case, you can include the URL within your script by using the ~StatusChangePostURL(posturl)~ command. This should be placed at the beginning of your script.

The last scenario includes incoming phone calls. To set the URL in this case, you can log into your account online and specify a URL for each dedicated phone number assigned to your license key as shown in the image below:

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.

 

 

 

0 views

CDYNE Launches 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

0 views

Is a DID Required When Using CDYNE SMS Notify! API?

One question we often get asked is, “Is a DID required to use your SMS Notify! API?” The short answer is yes. Every SMS Notify! account comes with one dedicated DID, which is an SMS-enabled phone number that allows you to send text messages. DIDs are useful for low volume, person-to-person text messaging, but more importantly they provide two key benefits:

  1. Build your application with the SMS Notify! API while implementing a dedicated short code
  2. Use DIDs as a backup system to short codes when a carrier is not supported

SMS Notify! uses DIDs and short codes to send and receive text messages from and to your application. Dedicated short codes take time for carrier approval and launch, but companies can still build and test their application with SMS Notify! by using DIDs.

DID Text Messaging Best Practices

  1. DIDs are meant for low volume, person-to-person text messaging. The SMS Notify! API throttles outgoing text messages at a rate of 1 message every two seconds per DID.
  2. CDYNE recommends not sending more than 500 outgoing text messages per DID per day. Sending more than this may put you at risk of the carriers flagging your DID traffic. If your volume per DID is higher than 500 per day, please contact CDYNE to add more DIDs to your account to balance the message load.
  3. Marketing messages are not allowed on DIDs. CDYNE offers short code text messaging for marketing messages. Please contact CDYNE for more short code details.

DIDs for Short Code Backup

CDYNE offers DIDs for low-volume, non-marketing messaging  which makes a nice backup to short codes in the case a carrier is not supported on the short code. This is an optional feature that can be set up during the short code sign up process.

Call 1-800-984-3710 for more information or test today for free.

0 views

Part 5: CDYNE Postal Address Verification DPV Code Suggestions

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:

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.

0 views

Part 3: CDYNE Postal Address Verification VerifyAddress Operation

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.

0 views

Part 1: CDYNE Postal Address Verification API Overview

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.

0 views