Acoustic

Integration type: User-defined
Supported functionality
Upload
- Upload — You can upload a list to schedule then send using the ESP's own functionality
- Upload & Broadcast — You can upload a list to the ESP to broadcast immediately
Broadcast
- Email — You can create an email broadcast in Orbit and PeopleStage
Documentation
Channel configuration in Orbit
Note
Values shown may be for example only; the options will differ for each broadcaster.
Basic details
| Name |
Description |
| Channel Name |
Enter a name for the channel |
| Broadcaster |
Select Acoustic from the drop-down |
| Broadcaster Username |
Enter your broadcaster API username, available from Acoustic |
| Broadcaster Password |
Enter your broadcaster API password, available from Acoustic |
| Update Password |
Displayed once a password has been set; use this to change the password if required |
| Test Login |
Use the Test Login button to confirm the above details are correct. A "Test login successful" message displays if the credentials are correct |
| Email Variable |
Select Email Address from the drop-down |
| Email Variable Description Override |
Optional—enter the description, for example "Email Address". This must correspond to the email field within Acoustic |
| Reply Email Address |
The email address that will receive notifications when the channel is used. This is NOT the reply email address used for the email send |
| Broadcaster Action |
The default is Upload and Broadcast; select Upload Only to upload the list only without initiating a broadcast |
Broadcast parameters
| Parameter Name |
Parameter Value |
| FTP Protocol |
Either sftp, ftp, or ftps |
| FTP URL |
This should refer to the FTP location; the default is Transfer[pod].acoustic.com |
| FTP Username |
Enter your FTP username |
| FTP Password |
Enter your FTP password |
| Private Key Path |
See table below |
| Client ID |
A unique alphanumeric string available from your broadcaster |
| Client Secret |
A unique alphanumeric string available from your broadcaster |
| Refresh Token |
A unique alphanumeric string available from your broadcaster |
| Admin From Email |
The email address that administrative emails are sent from |
| Dated List Format |
The date format string for the date and time stamp if created; default is yyyyMMdd-HHmmss |
| Visibility |
Choose your visibility: 0 = Private, 1 = Shared |
| Upload Only Contact List Folder |
The upload only folder |
| Upload And Broadcast Contact List Folder |
The upload and broadcast contact list folder |
| List Id Column Table |
The list ID column table |
| Master Table |
The name of the Acoustic database to use |
| Encoding |
UTF8 |
Common parameters
| Parameter Name |
Parameter Value |
| SFTP Private Key Path |
If secure FTP is used above and requires a private key, this should refer to the path and filename of that key |
| Use Dated List |
Setting this to false will remove the date and time stamp at the end of the file name. The default is true |
| Dated List Format |
Enter the date format string for the date and time stamp if created. The default value is yyyyMMdd-HHmmss |
| Name |
Value |
| Allow in Transactional Output |
Specific to PeopleStage and Transactional Campaigning. If you select Yes, multiple emails can be sent to the same email address |
| Append to List |
Optional |
| Number of Retries |
The number of times to retry on failure of the channel. Recommended (for Broadcast Channels) to leave this at 0 |
| Response File Key Type |
The key field to match responses to sends. Should be set to Communication Key for Acoustic |
| Message Content Type |
For email broadcasts this will always be Template (using the Broadcaster Template) |
| Retrieve Existing List Names |
Optional; not supported in Orbit at the moment |
| Name |
Value |
| Zip File |
Default is deselected; select this optional setting to compress the file if required |
| Output File Format |
Default is Comma Separated Values (CSV) |
| Output Header |
Default is Descriptions; will use the title of the variable in the header |
| Delimiter |
Default is Tab |
| Alpha Encloser |
Default is None |
| Numeric Encloser |
Default is None |
| Extras |
Empty by default; can reference the name of an Extras XML file. Reserved for advanced use |
| Encoding |
Default is UTF-8 |