Actions80
- 🚫 Blacklist Actions
- ➕ Add Phone to Blacklist
- ➖ Remove Phone from Blacklist
- 📋 List Blacklisted Phones
- 🌐 Add IP to Blacklist
- 🔄 Remove IP from Blacklist
- 📜 List Blacklisted IPs
- 📱 Get User SIP Numbers
- 🔄 Get SIP Route In
- ⚙️ Set SIP Route In
- 🎯 Add Campaign
- 📞 Add Phones to Campaign
- 🟢 List Free Users
- 📞 List Active Calls
- 🔄 Initialize Status Tracking
- 🔒 Encode Phone
- 🔓 Decode Phone
- 📡 SIP Routing Actions
- ➕ Add Phone to Blacklist
- ➖ Remove Phone from Blacklist
- 📋 List Blacklisted Phones
- 🌐 Add IP to Blacklist
- 🔄 Remove IP from Blacklist
- 📜 List Blacklisted IPs
- 📱 Get User SIP Numbers
- 🔄 Get SIP Route In
- ⚙️ Set SIP Route In
- 🎯 Add Campaign
- 📞 Add Phones to Campaign
- 🟢 List Free Users
- 📞 List Active Calls
- 🔄 Initialize Status Tracking
- 🔒 Encode Phone
- 🔓 Decode Phone
- 🎯 Campaigns Actions
- ➕ Add Phone to Blacklist
- ➖ Remove Phone from Blacklist
- 📋 List Blacklisted Phones
- 🌐 Add IP to Blacklist
- 🔄 Remove IP from Blacklist
- 📜 List Blacklisted IPs
- 📱 Get User SIP Numbers
- 🔄 Get SIP Route In
- ⚙️ Set SIP Route In
- 🎯 Add Campaign
- 📞 Add Phones to Campaign
- 🟢 List Free Users
- 📞 List Active Calls
- 🔄 Initialize Status Tracking
- 🔒 Encode Phone
- 🔓 Decode Phone
- 🔄 Presence Actions
- ➕ Add Phone to Blacklist
- ➖ Remove Phone from Blacklist
- 📋 List Blacklisted Phones
- 🌐 Add IP to Blacklist
- 🔄 Remove IP from Blacklist
- 📜 List Blacklisted IPs
- 📱 Get User SIP Numbers
- 🔄 Get SIP Route In
- ⚙️ Set SIP Route In
- 🎯 Add Campaign
- 📞 Add Phones to Campaign
- 🟢 List Free Users
- 📞 List Active Calls
- 🔄 Initialize Status Tracking
- 🔒 Encode Phone
- 🔓 Decode Phone
- 🔧 Utility Actions
- ➕ Add Phone to Blacklist
- ➖ Remove Phone from Blacklist
- 📋 List Blacklisted Phones
- 🌐 Add IP to Blacklist
- 🔄 Remove IP from Blacklist
- 📜 List Blacklisted IPs
- 📱 Get User SIP Numbers
- 🔄 Get SIP Route In
- ⚙️ Set SIP Route In
- 🎯 Add Campaign
- 📞 Add Phones to Campaign
- 🟢 List Free Users
- 📞 List Active Calls
- 🔄 Initialize Status Tracking
- 🔒 Encode Phone
- 🔓 Decode Phone
📡 SIP Routing → 🎯 Add Campaign
AI-generatedSummary
Create a new SIP routing campaign to autodial phone calls or send SMS messages to a specified list of phone numbers with customizable scheduling, retry, and routing parameters.
Inputs
- User Phone Number (required) — Internal user phone number used for obtaining SIP numbers or configuring routing.
- Campaign Initiator (required) — Internal number of the employee creating and launching the campaign.
- Phone Numbers (required) — Comma-separated list of phone numbers to be called or receive SMS, added to the campaign.
- Campaign Type (required) — Choose 1 for phone call autodial campaigns or 2 for SMS message campaigns.
- SMS Message — Text of the SMS message; required only if campaign type is SMS. Limited to 160 characters (70 for Cyrillic).
- Employee Extension — Extension number of the employee to receive campaign calls; defaults to the campaign initiator if not specified.
- Days of Week — Comma-separated weekdays on which to run the campaign (0=Sunday to 6=Saturday). Defaults to weekdays 1-5.
- Time Range — Time window in HH:mm-HH:mm format to run the campaign each day, avoiding early morning or late evening calls. Defaults to 10:00-18:00.
- Retry Attempts — Number of retries for each phone number. Default is 1 (single attempt). Range 1-10.
- PDD (Post Dial Delay) — Delay in seconds after dialing a number to fine-tune call timing. Default is 0.
- Preview Timeout — Seconds to wait in preview mode before call connects, allowing the operator to view client info before dialing. Default is 0.
Output shape
a single response object confirming the campaign creation
The operation returns confirmation from the LiraX API after creating the campaign. No pagination or item lists are involved.
Examples
Example 1: Create an autodial phone call campaign for a user to call specified numbers on weekdays between 9am and 5pm, with 2 retry attempts and no preview timeout.
Set User Phone Number, Campaign Initiator, Campaign Type to Phone Calls, provide a comma-separated list of phone numbers, specify Days of Week as '1,2,3,4,5', Time Range as '09:00-17:00', and Retry Attempts as 2.
Example 2: Launch an SMS broadcast campaign sending a specific message to a list of numbers on weekends.
Set Campaign Type to SMS Messages, provide the required SMS Message text, specify Days of Week as '0,6', and fill required phone lists and initiator information.