The API mapping screen allows you to import leads from your own API integration such as web leads.


If you are using API imports, the installations team will configure your initial mappings as part of onboarding. If you are adding new API imports to the system, you could clone an existing API mapping or create a new one from scratch.


Note - Please also see the attached document at the bottom of the guide which has more information on API integration.



The top left of the screen has two buttons, one to create a new API Import settings and one to clone an existing import settings. Once you have created or made changes, you can use the save button in the top right.

Templates

Here, you will see a list of all the API Import templates created on your system. Selecting each one will allow you to see the Options and Mappings set for each template. When you select the 'new' button to add a new template, it won't appear in the list until you have saved the template.

IMPORT_API_MAPPING.png

Options

The options section gives you the ability to control what the API import does with the import, much like the settings when doing manual imports.

Name - Here, you can give the import a name.

High Priority - Ticking this will push the import to the front of the queue. This feature is good when used with importing web leads.

Description - Here, you can add a description of the import to help distinguish between different ones.

Supplier - You must add a supplier to each import. If the relevant supplier doesn't appear in the drop down menu, you can click the next to the drop down to add a new supplier. Simply type in a name for the supplier and hit the  that appears to save it.

User - There should be a default user created on the system to use for API imports (with a username & password) Here, you should select that user. 


List options - Here you will find 3 radio buttons to select from;

  • Specified List - This will allow you to select a single list to import the data to. This can be done by selecting the required list from the drop down 'List', located under the 3 radio buttons.
  • Create New List Per Import - Allows the system to create a new list with every import done with these settings. Firstly, you will be able to select a list to clone from the drop down, doing this... You will also see a box where you can enter a List Name (Prefix) which will have the date added to it once imported onto.
  • Create New List Per Day - Selecting this will give you the same options as 'Create New List Per Import'.


Response URL - The response URL is a URL which we will send a request to after a import has failed or completed. This will be a POST request. This will be either json or xml depending upon the request format you set.

Request Format - Allows you to select either Xml or Json as the format.

Call Info - (Similar to manual import stage with the same name) Here, you can add information that the agents can see within web agent.  This area is free type and to include lead info you will need to use 'curly brackets' {{ }}, to add in the relevant field.

Delete Existing Records - This option gives you the ability to delete existing data from the list selected, meaning all existing leads will be deleted and replaced with the new leads from the import. This option needs to be used with caution as the data will NOT be recoverable if you select this option.

Add Leading Zero - Checking this will make the system go through and check the leads to see if they have a leading zero (0). If it is not there then the system will automatically add one.

Remove Non-Digits - Checking this box will make the system go through and check the leads for any character that isn’t a number such as + , - , # and will subsequently remove them.

Min Phone Number Length - The minimum phone number length will tell the system to look for a minimum of X digits (X being the value selected). You should try to verify phone number lengths in the import file before setting this value to ensure that they do not mistakenly disregard valid records. The key principal behind setting the minimum phone number length is to stop the system from importing numbers such as 999 and numbers which are not valid.

Max Phone Number Length - Max phone number length tells the system to disregard any numbers longer than the number of digits specified from the drop down box. Once again, verify the lengths of the phone numbers in the import file before setting this value, so not to disregard any valid records.

Check DNC - Checking this option will tell the system to check every number in the import against the DNC (Do Not Call) list in the system and if any of the records do appear on the DNC list, they will be excluded from the import.

Checking this will also open up standard DNC settings check boxes and show the defaults IVR, imported and requested.

Deduplication - Checking the deduplication box will display the following options;

  • File Uploaded– Any duplicates within the file will be excluded from the import. So, if you have 2 of the same phone number in the file, only one of them will be imported.
  • Dedupe against the list you have selected for import - Any duplicates found which match the import data contained in the selected list will be excluded from the import.
  • Dedupe against additional lists? – Here you select any specific lists that you want the system to check for duplicates. Tick the box and then select the additional lists from the drop down.
  • Global(entire database )– Any duplicates found that match your data that are contained in the database, i.e in any of the lists you have, will be excluded from the import.  
  • Action – in this drop-down there are 3 options to choose from;
  • Keep Existing - When a duplicate is found, if the record already exists in the database, Keep Existing will keep the duplicate record found in the database and will exclude the new record from the import.
  • Keep New - On the other hand, if a duplicate is found in the database Keep New will remove the existing record (Regardless of what information is on the system) and will upload the ‘new’ record from the import. 
  • Reset Older - This will update/reset the existing record in the system making it eligible for dialling and will then reject the new record and exclude it from importing (So if a number has been dialled and was a success for example, it will be reset and the number will be called again).

Static Time Zone - This is commonly used in call centres which dial across multiple time zones. Setting this option will force the data being imported to be marked with a specific time zone. Once marked with a time zone, calling plans will dictate when the records should be dialled. You will already have a time zone created for your specific country for calling. Upon selecting this, the following will appear;

  • Default Time Zone - Here, the user can set the default time zone for the leads being imported onto the system.

Calling Code - Here, the user can add the calling code for the leads imported if required.  This will generally be used for international numbers that are usually imported without the 'area code'.

Mappings

Here, you can map fields from the MaxContact system to your API import information.  E.g, mapping a name input from an online enquiry to a name field within MaxContact, which then presents agents with the customer name on the script within Web Agent.

Primary Key Field - This feature is no longer in use and can be ignored.


Primary

+ button adds a new File Header and Field Name input box.

File Header - This is the name of the location of the information, e.g. CSV header, input header.

Field Name - This is the corresponding field name within the MaxContact system.

Ignore Secondary Mapping - Leaving this unticked will allow you to map all other information from the import to MaxContact.  

If you tick this, you will ignore the secondary mapping completely.

Secondary Table - Allows you to select a secondary table on the system that already has fields created to use for mapping.


Secondary

+ button adds a new File Header and Field Name input box.

File Header - This is the name of the location of the information, e.g. CSV header, input header.

Field Name - This is the corresponding field name within the MaxContact system.


Third Party

This feature is no longer in use and can be ignored.