IntroductionThis document provides an overview of the LiveVox Adding/Appending Records to Active Campaigns features. FeaturesThe Append Campaign Record APIs are supported on all GA (General Availability) releases of the platform. Only Sysadmin, Superuser, and Manager user role types have access to campaign appends. Requeue campaigns do not support append functionality. The Append functionality contains the following features: - Records can only be appended to "today's” campaigns. Enhanced campaign append functionality which allows the service level dialing sort to be superseded for priority record handling is available as of LiveVox U10. This allows appended campaign records to be handled with priority over existing campaign records.
- The 'Append Campaign Record' API method only works on campaigns that have the Allow Append option enabled.
- You can append new records to active campaigns only in Built, Pause, or Play status. New transactions appended to campaigns in the Stop status are not supported.
- The target Campaign ID is required to use this functionality. The Campaign ID can be retrieved during the campaign upload process or by using one of the following API method:
- Find Matching Campaigns - List Campaigns For more information, see Search the Campaign ID. It is recommended that you use one of the above API method to gather the Campaign ID and then use that information to insert the Campaign ID into the Append Campaign Record API call. For more information, see the User Hub’s Developer Portal under the Campaign API documentation section on Find Matching Campaigns, List Campaigns, and Append Campaign Record API. The Developer Portal is available from the Resources drop-down menu of the voice portal. Image Modified
- For appended records, the related Campaign name is displayed in standard reports including the Account Lookup Report and Phone Lookup Report within the LiveVox portal.
Special ConsiderationsAppend Campaign FunctionalityEnable Campaign Appends You can enable Campaign Appends in the Client section of the voice portal by following the procedure below: - Navigate to Configure > Client/Service > Client > Settings tab.
- Click Campaign Appends Allowed in the Advanced Features section.
Image Modified
Allow Append CampaignsTo allow appending on a campaign, follow the procedure below: When uploading a campaign, click the Allow Append option from the Advanced tab. This allows campaign records to be appended to the active campaign. Note |
---|
You can find the Upload a file option by navigating to Configure > Campaigns > Campaigns from the navigation panel. Detailed instructions on uploading a campaign and assigning dialing characteristics are available in the User Guide on User Hub. |
Image Modified - Click Upload to upload the campaign file.
If you enable the Allow Append feature for a Campaign, the campaign displays a green checkmark in the Allows Append column 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.
Image Modified The Allow Append option is also viewable in the Campaign details screen but cannot be modified. Image Modified Append Campaigns Report at End of DayThe Services section displays the Append Campaigns Report at End of Day in the Settings tab. - If enabled, append enabled campaigns to generate a report at the end of the day. This allows additional records to be appended even if no dialable records are remaining in the campaign.
- If disabled, campaigns will report when they run out of dialable records. Once a campaign is in the Done or Reported status, no additional records can be appended to the campaign.
Image Modified Appending Records to Active CampaignsFind Appending records to active campaigns uses the Append Campaign Record API method. For more information on using LiveVox APIs, see the Developer Portal. Follow the procedure below to append new records to campaigns. 1. Establish User SessionTo append records, you must establish an API user session with the LiveVox platform. 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 log in – client name, username, and password. User can access the LiveVox voice portal (LVP) https://login.livevox.com, which allows them to perform administrative tasks on the platform. If you are unable to log in to the LiveVox Platform, contact customercare@livevox.com for help in troubleshooting the issue. Note |
---|
Only Sysadmin, Superuser and Manager user role types can append records. |
Once the API request is made, a response containing the 'session id' and the client id to be used in subsequent requests is returned.
|