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.
...
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 10 minutes1 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.
...
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.
Concurrency
The no. of concurrent calls to insert lead is limited by the number of hardware threads your server runs. The limit is set to (No. of hardware threads / 2).
If someone is running a manual import then the InsertLead call will fail, so be prepared to do retries.
Retries
You must expect calls to InsertLeads InsertLeadFast to fail so make certain your code can retry the action. If an insert fails then wait a couple of minutes before retrying (a manual import will cause a insertion failure).
Entry point:
Lead data must be POSTed and encoded as json.
| Code Block | ||
|---|---|---|
| ||
https://<server host>/servicemanager/rest/CampaignAPI/insertLeadsFastinsertLeadFast |
URL Parameters:
| Parameter | Description | Required |
| fTemplateId | Campaign Template id of the Template that the lead will be associated with. See 16.0 Get Campaign Template List to obtain Template Id's | Yes |
| fCampaignId | Campaign id of the Campaign that the lead will be associated with. See 17.0 Get Campaign List to obtain a list of campaign Id's. | Yes |
| fAllocationId | Allocation id of the Campaign that the lead will be associated with. See 18.0 Get Allocation List to obtain a list of allocations. | Yes |
| allowDuplicates | If true checking for duplicate phone numbers will NOT be performed . | No |
| apiKey | api key provided by Noojee Support | Yes |
...
| Parameter | Description | Required |
| njExternalLeadId | A reference, account number or the like taken from the external data source. Also used to identify lead when updates are made. | No |
| njCallBackDate | The date and time on which the lead is to be called. If not specified the lead is treated as a 'new' lead and will be called on a first come first served basis. Format is "yyyy/MM/dd HH:mm". Note that when setting a call back date the time is treated as being in the Contact Hours timezone. If you want to inject a lead to be dialed immediately then you need to convert the current time to the contact hours time. Noojee Contact will normally be configured so the 'system time' is in the timezone where the main team is located. | No |
| njPriority | A priority between 0 and 100. The lower the number the higher the priority. Higher priority leads will be called before lower priority calls. Default priority is 10. | No |
| njContactHours | Sets the Contact Hours for the lead. If not passed the lead will default to the Campaign Templates default Contact Hours. | No |
...
| Code Block |
|---|
{"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:
| Code Block | ||
|---|---|---|
| ||
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' |
...
| Code Block | ||
|---|---|---|
| ||
{"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).
| Code | Message | HTTP status | Description |
|---|---|---|---|
| 0 | OK | 200 | The lead was successfully inserted or updated. |
| 102 | NO_PHONE_FIELDS | 400 | The lead doesn't contain any fields designated as phone number fields. |
| 103 | EXCEPTION | 500 | A server error occured. Call Noojee Support. |
| 104 | DNC | 400 | The lead's phone numbers are on the DNC list |
| 105 | DUPLICATE | 400 | There is already a lead with this phone number |
| 106 | INVALID_DISPOSTION | 400 | When updating, the supplied disposition doesn't exist. |
| 107 | DISPOSTION_ISNT_SET_AND_NOCHANGE_SPECIFIED | 400 | When updating a a lead the disposition can be omitted, and <NO CHANGE> specified. But this is an error condition if the lead doesn't already have a disposition. |
| 108 | IMPORT_BUT_NOCHANGE_SPECIFIED | 400 | Tried to insert a lead but a field contained the value '<NO CHANGE>' which is only valid for updates. |
| 109 | TIMEOUT_TOO_MANY_CONCURRENT_REQUESTS | 400 | There are too many concurrent insert/update API requests. Wait a bit and then retry the insert/update. Currently a call will timeout if it is delayed by more than 1 minute. Note: you MUST have a timeout in excess of 60 seconds on your requests as our system can can take up to 1 minute to respond. |
| 110 | LEAD_NOT_UPDATED_DUE_TO_CONFLICT | 400 | The lead update caused a conflict with another update and failed. This usually means that a user was editing the lead whilst you were trying to update it via the api. This type of issues should be rare as in most cases the user will see the error not the api. When the user sees the error they will be given the opportunity to merge the two leads via a specialised merge lead screen. If the api recieves this error then you will need to manually intervene to ensure that data isn't over-written which a simply retry is likely to do. |
| 111 | INVALID_TIMEZONE_SPECIFIED | 400 | The lead contained an unknown Contact Hours (timezone). |
| 112 | DUPLICATE_EXTERNAL_ID | 400 | The value passed via njExternalLeadId already exists in the Campaign. |
| 114 | INVALID_CALLBACK_DATE_FORMAT | 400 | The supplied callback date is in an invalid format. |
| 115 | ALLOCATION_ID_REQUIRED | 400 | A valid Allocation ID was not passed in. |
| 116 | TEMPLATE_ID_REQUIRED | 400 | A valid Campaign Template ID was not passed in. |
| 117 | CAMPAIGN_ID_REQUIRED | 400 | A valid Campaign ID was not passed in. |