LeadStream - Vendor Integration

LeadStream - Vendor Integration

How to leverage PhoneBurner's industry-leading lead delivery technology.

Overview

LeadStream is a lead delivery and management platform for teams.

This proprietary technology gives administrators the ability to intelligently distribute leads among their sales team, and into the core contact management and dialing platform within each user's PhoneBurner account.

LeadStream features a rich and highly customizable set of delivery options - including Blind Pull, Preview Pull, Round Robin, and LeadBlitz - that dictates how these leads get distributed and used.

This document details how to post new Leads to your account. Each LeadStream has a unique data point assigned to it (cm_id). You will need to include this data point in order for each new lead to post successfully to your LeadStream.

Lead Delivery Route

The base LeadStream URL path/route is:

https://www.phoneburner.com/api/vendor/put_contact

Data is sent to this URL using a GET method with the following parameters:

• key - unique vendor key. This must be included in every post. Each lead vendor must have a unique Vendor Key. if you are working with a vendor who hasn’t sent data to PhoneBurner before please reach out to PhoneBurner so we can get them setup with a Vendor Key.
• user_id - the unique id of the the account that is building and managing the LeadStreams. Your PhoneBurner user ID can be found on this page https://www.phoneburner.com/myaccount/personal_info
• firstname - first name of lead
• lastname - last name of lead
• email - email of lead (This is a required field)
• phone - phone of lead
• address1 - address of lead
• address2 - address line 2 of lead
• city - city of lead
• state - state of lead
• zip - zip of lead
• country - country of lead
• cm_id - unique LeadStream id. This is the folder ID for your LeadStreams Distribution Folder
• promocode - No+E-mail+Leads (add this parameter if you don’t have email addresses for your leads)
• allow_duplicates - 1 (By default the system will try to block duplicated records from coming into the system if the account receiving the leads already has a contact with the matching email address. If you wish to always treat each new lead as a new record you can include this parameter to allow duplicates

Additional Custom Fields

Sending additional data or custom fields to PhoneBurner using the Vendor endpoint is also possible. This is useful if you have data that you want to send that doesn’t fit within the standard fields listed above. The vendor Endpoint does NOT allow new custom fields to be created on your behalf so you will need to get a list of your custom fields and the corresponding ID’s for those fields from the PhoneBurner directly and can easily be found

The custom field parameters look like this

custom_field[~UniqueID~]

You can easily get a full “Custom Field Legend”, which contains a list of all parameters available on your account, on the “Distribution Folder” step when creating your LeadsStream (if you are not sure how to get this please reach out to [email protected]). The list of fields will include each parameter listed out and the value you should send for each field. For example:

custom_field[195481]=Follow Up Date&

Where “custom_field[195481]” represents the parameter and “Follow Up Date” is the name of the field in PhoneBurner so you know what value you should send with that parameter.

Custom fields can be either text, date, or check boxes.

• Text boxes : values are limited to 255 characters.
• Dates : values are formatted in MM-DD-YYYY format.
• Checkboxes : values are "yes" for checked.

Additional Phone Numbers

PhoneBurner supports contacts with multiple phone numbers. Any additional phone numbers would need to be sent over using the Additional Phones array

additional_phones[]=2nd phone number

additional_phone_types[]=2nd phone number type (1: Home 2: Work 3: Mobile 4: Fax 5: Other)

additional_phone_labels[]=2nd phone label

‍

Tags

PhoneBurner supports Tagging contacts. To include any tags with your contacts you would need to be send them using the Tags array

tags[]=First Tag

tags[]=Second Tag

etc

‍

Example lead delivery

Here is an example lead delivery GET that uses some of the most common data points.

https://www.phoneburner.com/api/vendor/put_contact?key=XXXYYYZZZ&firstname=Jeff&lastname=Sample&[email protected]&phone=(716) 293-2368&address1=114 Hickory St&address2=Apt 23&city=Buffalo&state=NY&zip=14204&custom_field[297989]=75048327&custom_field[195481]=12/24/2017&user_id=377310706&cm_id=576846&additional_phones[]=(702) 530-6954&additional_phone_types[]=2&additional_phone_labels[]=Work&additional_phones[]=(646) 362-7327&additional_phone_types[]=1&additional_phone_labels[]=Home&tags[]=Hot Lead&tags[]=Lead Type

In the above example we have 2 custom fields we are sending data into:

custom_field[297989]=Reference #

custom_field[195481]=Follow Up Date

‍

We are included 2 additional phone numbers:

additional_phones[]=(702) 530-6954

additional_phone_types[]=2

additional_phone_labels[]=Work

additional_phones[]=(646) 362-7327

additional_phone_types[]=1

additional_phone_labels[]=Home

‍

And we are sending 2 Tags:

tags[]=Hot Lead

tags[]=Lead Type

‍

Lead Delivery Responses

If your post is successful you will get a response like this:

SUCCESS|https://www.phoneburner.com/ms/lead_redirect? upc=ATFHD3PP

The first element SUCCESS tells you the lead was accepted. The second element is a unique URL for the lead and can be ignored.

If the post is not successful because you are delivering to a user_id that does not exist, you will get a response like this:

FAILURE|UNKNOWN USER

First element says FAILURE. Second element is the reason for the failure. For example, if you posted with an invalid e-mail address you would get this response:

FAILURE|INVALID EMAIL

Here is a list of all the possible error codes:

• ERROR|IDNUMBER IS REQUIRED

• ERROR|UNKNOWN USER

• ERROR|CANCELLED USER

• ERROR|INVALID EMAIL

• ERROR|DUPLICATE EMAIL

• ERROR|CM_ID IS REQUIRED

• ERROR|CM_ID IS INVALID

• ERROR|BAD RESPONSE TYPE

‍