Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
To allow appending on a campaign, follow the procedure below:
Campaign files with campaign append allowed display If you enable the Allow Append feature for a Campaign, the campaign displays a green checkmark in the Allows Append column in of the Campaigns section. You must enable the Allow Append column view through the Customize Campaigns Grid configuration option as this is not visible in the default Campaigns view. The Allow Append column This option is also viewable in the Campaign details screen . This attribute is displayed as read-only. Allow Append option but cannot be modified.
Anchor |
|
Info | ||
---|---|---|
| ||
Appending records to active campaigns uses the Append Campaign Record API method. For further more information on using LiveVox API's refer to APIs, see the Developer Portal link from the voice portal. Having uploaded a campaign, as described previously in this document, follow these steps . Follow the procedure below to append new records to campaigns.
Establish User Session
Anchor eus eus
1. Establish User Session
eus | |
eus |
To append records, you must establish an API The first step required is to establish a user session with the LiveVox platform. The session API is necessary This is required because it returns a 'session Id' which must be passed with every subsequent API call. The session API requires three elements to login log in – client name, username, and password. The session API accepts both User and Agent credentials.
User accounts can access the LiveVox voice portal (LVP) https://login.livevox.com, which allows them to perform administrative tasks on the platform. Agent accounts are used to log into the ACD to take make and receive calls. For this section, a user account is usedrequired. To determine if you are using a user or agent account, simple try log in to log into the LiveVox Portal. If you can login log in to the LiveVox portal, you can login log in to the LiveVox APIs as a user. If you are unable to login log in to the LVP LiveVox Platform, contact support@livevoxcustomercare@livevox.com for for help in troubleshooting the issue.
Note |
---|
Only Sysadmin, Superuser and Manager user role types can append records. |
Once the API request has been is made, a response is returned containing the 'session id' and the client id to be used in subsequent requests is returned.
Anchor fci fci
2. Find the Campaign ID
fci | |
fci |
Locating the Campaign ID Before using the The Find Matching Campaigns API. Prior to using the Find Matching Campaigns API, the campaign must first have a Campaign ID in on the platform. This is achieved by first You can generate a Campaign ID by loading the initial file into the platform. Once the file is loaded, the Campaign ID is generated as shown below on the General tab of the Campaign details.
Sample Campaign ID and Service ID displayed in Campaign Details
Alternately, the Campaign ID can be retrieved using the 'Find Matching Campaigns' API method.
To A typical way to locate the appropriate Campaign ID is to load the initial file at a certain time of day and then use using the Find Matching Campaigns API to perform a search by against the time and Service ID associated with the target campaign. You can also supply the expected campaign state and type when searching as well. This will provide provides the Campaign ID to use in subsequent append requests to that campaign.
Search for campaigns for client id limited to only 10 records at a time. Specified Specify the date Range range with a 15-minute interval in the "from" and "to" element. The "from" and "to" values are in number of milliseconds since Epoch and use uses a third-party site, https://currentmillis.com, to aide 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 (See Figure 13). The "type" is set to a "1" for Outbound.
From the Response, we should receive the Campaign ID in the "campaign" array under the "id" element. This id ID is to be used for the append operation. The following is the code snippet.
Find Matching Campaign example
Append Record to Campaign
an example of the Request and Response.
Anchor arc arc
3. Append Records to a Campaign
arc | |
arc |
After you generate the Campaign ID, you can append records to the target campaign. In addition to the LV-Session API Once the Campaign ID has been obtained, the next step is to append a record to the campaign. Along with the LV-Session 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 can be added as needed to further identify the appended records. |
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 the code snippet.Append Records to a Campaign examplean example of the Request and Response.
After submitting the append request, a status code of 204 should be returned indicating the record has been successfully added to the campaign.
Viewing Anchor var var
4. View Appended Records
var | |
var |
To view your appended records on the selected campaign, navigate to the Campaign details screen and select the Campaign Records tab. You will be able to view a new record, including newly added phone numbers on the Phone 2 column.
Appended record in Campaign Details screen
Real-Time Statistics for Appended Campaign
Real-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. |
Noprint |
---|