LiraX Admin icon

LiraX Admin

System administration, SIP, Blacklist and Campaigns

Actions80

🚫 Blacklist → 🎯 Add Campaign

AI-generated

Summary

Add a new campaign to the blacklist system to initiate either automated phone calls or SMS messages to a specified list of phone numbers according to scheduled days and times.

Inputs

  • User Phone Number (required) — Internal user phone number used to obtain SIP numbers or configure routing.
  • Campaign Initiator (required) — Internal extension number of the employee who creates and starts the campaign.
  • Phone Numbers (required) — Comma-separated list of phone numbers that will be added to the campaign for calling or SMS.
  • Campaign Type (required) — Type of campaign: phone calls (autodialing) or SMS broadcast.
  • SMS Message — Text of the SMS message; mandatory if campaign type is SMS (limited to 160 chars, 70 for Cyrillic).
  • Employee Extension — Extension number for the employee who will receive campaign calls; defaults to the campaign initiator if not provided.
  • Days of Week — Comma-separated days of the week when the campaign should run, where 0=Sunday and 6=Saturday; default is weekdays (1 to 5).
  • Time Range — Time window for the campaign in HH:mm-HH:mm format, restricting call or SMS times; default is 10:00-18:00.
  • Retry Attempts — Number of retry attempts per phone number (default 1 means single attempt).
  • PDD (Post Dial Delay) — Delay in seconds after dialing each number used for fine-tuning call timing.
  • Preview Timeout — Timeout in seconds for preview mode allowing operators to see client info before the call.

Output shape

a single object representing the created campaign or an acknowledgement of successful creation

The operation returns data confirming the addition of the campaign to the blacklist system. If the campaign type is SMS, the message property must be provided. The campaign scheduling respects specified days and time windows. Error handling is managed internally with retries for robustness.

Links

Discussion