...
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
To allow appending on a campaign:
Campaign files with campaign append allowed display a green checkmark in the Allows Append column in 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. Allow Append column This is also viewable in the Campaign details screen. This attribute is displayed as read-only. Allow Append option
Anchor |
|
Info | ||
---|---|---|
| ||
Appending records to active campaigns uses the Append Campaign Record API method. For further information on using LiveVox API's refer to the Developer Portal link from the voice portal. Having uploaded a campaign, as described previously in this document, follow these steps to append new records to campaigns.
Anchor | ||||
---|---|---|---|---|
|
The first step required is to establish a user session with the LiveVox platform. The session API is necessary because it returns a 'session Id' which must be passed with every subsequent API call. The session API requires three elements to login – 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 and receive calls. For this section, a user account is used. To determine if you are using a user or agent account, simple try to log into the LiveVox Portal. If you can login to the LiveVox portal, you can login to the LiveVox APIs as a user. If you are unable to login to the LVP contact support@livevox.com for help in troubleshooting the issue.
Note |
---|
Only Sysadmin, Superuser and Manager user role types can append records. |
Once the API request has been made, a response is returned containing the 'session id' and the client id to be used in subsequent requests.
Anchor fci fci
Find the Campaign ID
fci | |
fci |
Locating the Campaign ID using the The Find Matching Campaigns API. Prior to using the Find Matching Campaigns API, the campaign must first have a Campaign ID in the platform. This is achieved by first 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
A typical way to locate the appropriate Campaign ID is to load the initial file at a certain time of day and then use the Find Matching Campaigns API to search by the time and Service ID associated with the campaign. You can also supply the expected state and type when searching as well. This will provide 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 the date 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 a third-party site, https://currentmillis.com to aide 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 is to be used for the append operation. The following is the code snippet.
Find Matching Campaign example
Anchor arc arc
Append Record to Campaign
arc | |
arc |
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 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.
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 example
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
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 the Campaign Details screen