Documentation Index
Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt
Use this file to discover all available pages before exploring further.
Setting Up Outbound Campaigns
NLPearl.AI provides robust features to manage outbound campaigns efficiently. Using the Pearl flows you have created, you can set up outbound conversations to engage with your leads according to a predefined schedule.What are Outbound Campaigns?
Outbound campaigns enable your AI agents to start outgoing conversations with a list of leads. These conversations follow the conversational logic defined in your Pearl, ensuring consistent and effective communication with your potential clients.Steps to Create an Outbound Campaign
Create a Pearl
To get started, create the Pearl that best fits your outbound use case.
Simple Pearl
Ideal for quick setups or basic use cases. Easy to configure and perfect for testing or lightweight interactions.
PearlVibe
Designed for more complex scenarios, including multi-step logic.
Connect a Channel
Unlike a voice campaign, an outbound text campaign is not tied to a phone number. Instead, it is connected to a messaging channel, the place where your conversations with leads will take place.Connect the channel your campaign will use, such as:
- Telegram
- SMS
- Glassix
Assign the Channel to Your Campaign
Link the connected channel to the Pearl you want to use for handling outbound conversations. This connects your conversational flow to real-world interactions.
Configure Outbound Settings
Set up your outbound parameters, such as:
- Name: The name of the outbound campaign to easily identify its purpose and target audience.
- Pearl: Choose the Pearl that defines the conversation flow for this campaign. The AI will follow this predefined script when interacting with leads.
- Timezone: You can set a specific timezone for your campaign to ensure all actions are triggered at the right local time for your leads.
- Budget: Define the budget for your campaign. Once the budget is reached, Pearl will stop starting new conversations for that campaign. This is optional, and you can always increase it if you have enough credit in your account.
- Message Limit: Define the maximum number of messages a single conversation can reach before it is automatically closed. This helps control conversation length and keep interactions focused.
- Auto-close After Inactivity: Automatically close a conversation when the lead has been inactive for a defined period of time.
- Inactivity Follow-up: Automatically send a follow-up message when the lead stops responding for a set amount of time, to re-engage them before the conversation is closed.
-
Schedule Conversations: Define the schedule for when the AI agents will start the outbound conversations. You can specify dates, times, and frequency to suit your campaign needs.
- Chat Webhook: A chat webhook is triggered at key points during the conversation lifecycle, such as when a conversation starts and when it ends. You receive an object similar to the one returned by the Get Calls endpoint, including details like the conversation outcome and any data collected during the conversation. This is useful for tracking performance and automation.
- Lead Webhook: A lead webhook is triggered every time a specific lead changes status, at the beginning of the conversation and at the end of the conversation. You receive an object similar to the one returned by the Get Leads endpoint. This includes all relevant information about the lead and its current status. Use this webhook to update your CRM or lead management system in real-time, ensuring that you have the most up-to-date information on lead interactions.
Add Leads
Easily add the leads you want to contact directly from the platform. You can enter lead details such as name, contact identifier (e.g. phone number or messaging handle), and any other relevant information.
Step 2: Choose how you want to add your leads:
Option 1: Upload a File
Option 2: Add Manually
| Step | Action | Description |
|---|---|---|
| 1 | Go to âLeadsâ | Navigate to the Leads tab in your campaign sidebar. |
| 2 | Click âAdd Leadâ | Open the lead addition modal to choose between manual entry or file upload. |
Option 1: Upload a File
| Step | Action | Description |
|---|---|---|
| 1 | Click Upload File | Start the file upload process. |
| 2 | Download Template | Download a pre-filled CSV template including only variables used in your Pearl. |
| 3 | Fill and Upload | Complete the template with your lead data, then upload it back to the platform. |
When you download the template, the file will only contain column names for the variables actually used in your flow. If you create a variable but donât use it, it wonât appear in the file.If you manually add new columns that arenât linked to your Pearl, they wonât be recognized when re-uploading the file.
| Step | Action | Description |
|---|---|---|
| 1 | Click Manually | Switch to manual lead entry mode. |
| 2 | Enter Lead Data | Fill in lead details directly in the platform, one by one. |
Agents
Understand how to manage your agents, including adding and configuring agents for your inbound and outbound activities.
Post-Chat
Review everything captured after a conversation, from transcript to summary.