Inserts a lead into a designated Campaign/Allocation ready to be dialed.

The timing of when the lead will be dialed depends on the normal lead prioritisation mechanism (priority, callback date, balance mode etc) however the lead won't be considered until the next dialer cache refresh occurs. Cache refreshes occur every two minutes, so on average, injected leads will take at least one minute before they will be considered for dialing.

The endpoint InsertLeadFast replaces the original InsertLead method. The new endpoint takes the same arguments but has enhanced error codes and as the name implies is faster than the original InsertLead endpoint.

Performance considerations

Injection of leads into Noojee Campaigner is a 'heavy weight' process (it can take a long time) as each lead needs to be de-duplicated and activated.

In order to protect the core function of the PBX the end point is rate limited. The api allows multiple concurrent calls limited to (No. of hardware threads / 2) and each call we never complete in less than 100 ms. On larger databases the time required to complete each insert may increase further.

Note: the rate limiting is across both the UpdateLeadFast and InsertLeadFast combined.

If you exceed the above rates the system will queue additional requests. This may result in your call to the endpoint timing out (currently timeout is 1 minute). If your call to the InsertLeadFast endpoint times out then the lead will not be inserted and you will need to retry the insertion.

Queue insertions

As the end point is rate limited we strongly recommend that you queue the inserts within your system and include retry logic if the insert fails. This will deal with the above rate limiting logic as well as provide guaranteed delivery even if the Noojee PBX goes down for maintenance.

Retries

You must expect calls to InsertLeadFast to fail so make certain your code can retry the action. If an insert fails then wait a couple of minutes before retrying.

Entry point:

Lead data must be POSTed and encoded as json.

https://<server host>/servicemanager/rest/CampaignAPI/insertLeadFast

URL Parameters:

System fields that can be part of the json data:

Syntax

The format of the data posted is a json containing one or more sets of name value pairs:

{"fieldname1": "lead 1 field 1 value", "fieldname2" : "lead 1field 2 value"}
, {"fieldname1": "lead 2 field 1 value", "fieldname2" : "lead 2 field 2 value"}

Curl Sample query:

curl -v -H "Accept: application/json" -H "Content-Type: application/json" -X POST 
-d '{"Name":"Jane Smith","StreetAddress":"Suite 8/10 Hoddle St", "City": "Abbotsford", "State":"Vic"
, "PostCode":"3064", "FirstPhone":"0383218199"}' 
'https://<server host>/servicemanager/rest/CampaignAPI/insertLeadFast?fTemplateId=41&fCampaignId=41
&fAllocationId=38&apiKey=f863246a-973e-11e6-8784-08002718f5b5&allowDuplicates=true'

Sample success response:

{"code":0,"message":"OK"}

Error Codes

The API returns a HTTP status code and an json error code as follows:

HTTP status of 200 is returned when the lead was successfully inserted or updated.

HTTP status of 400 is returned when you passed some invalid data.

HTTP status of 500 is returned if our system throws an exception (our code is broken).