Specify the date range with a 15-minute interval in the "from" and "to" element. The "from" and "to" values are in milliseconds since Epoch uses a third-party site, https://currentmillis.com, to aid in generating the values. The "state" element is set to match the possible states we expect the campaign to be in when performing the search. The "service" element contains the Service ID that the campaign is configured for in the platform. The "type" is set to a "1" for Outbound. From the Response, we receive the Campaign ID in the "campaign" array under the "id" element. This ID is to be used for the append operation. The following is an example of the Request and Response. Info |
---|
Search for campaigns for client id limited to 1000 records at a time. |
Image Modified List Campaigns API MethodThis method provides the list of loaded campaigns for a client. To locate the appropriate Campaign ID using the List Campaigns API, you can specifies the number of items to return in the list (count) and start listing from the count (offset). This provides the Campaign ID to use in subsequent append requests to that campaign. From the Response, we receive the Campaign ID in the "campaignDetails" array under the "id" element. This ID is to be used for the append operation. The following is an example of the Request and Response. Info |
---|
Search for campaign ID limited to 1000 records at a time. |
Image Added 3. Append Records to a CampaignAfter you generate the Campaign ID, you can append records to the target campaign. In addition to the LV-Session API token, the Campaign ID must be included as a URL parameter in the HTTP PUT request along with a simple record containing (at minimum) a phone number. Only the "phone1" element is required by the Append Record to Campaign API, but additional information such as account number, names, email, etc. can be submitted. Note |
---|
- As a best practice, it is beneficial to append records with "phone1" and the "account" for screen pop and reporting purposes. Additional
| fields - properties can be added as needed to further identify the appended records.
- The "practicePhoneAlternate" is an optional property and it is the best practice to include this property in the request. If the "practicePhoneAlternate" property is not included in the request then the caller ID will be null.
|
You can enter additional phone numbers using the phone2 field. This should be entered as an array of phone numbers. This field can be filled with up to 30 additional phone numbers separated by a comma. In this example, two additional phone numbers are added to the appended record. The following is an example of the Request and Response. Image ModifiedAfter submitting the append request, a status code of 204 should be returned indicating the record has been successfully added to the campaign. 4. View Appended RecordsTo view your appended records on the selected campaign, navigate to the Campaign details screen and select the Campaign Records tab. Image Modified Real-Time Statistics for Appended CampaignReal-time campaign statistics are updated to reflect the appended campaign records within the LiveVox Portal. The below list provides the cumulative list of all the fileds on the various campaign monitor panels. Each configured campaign monitor panel will display only the relevant fields applicable to it.
- Uploaded: Number of records uploaded in original campaign and all records appended in the campaign
- Loaded: Number of valid records in original campaign and all records appended in the campaign
- Completed: Number of dialed records
- Remaining: Number of records yet to be dialed
- % Completed: The percentage of records that have completed dialing.
- Total: Total number of valid records in the original campaign and all records that are appended in the campaign.
- % Done: The percentage of records that have completed dialing.
Info |
---|
| Loaded and Uploaded values are updated regardless of whether the campaign is playing or not. |
|