LiraX Admin icon

LiraX Admin

System administration, SIP, Blacklist and Campaigns

Actions80

🔄 Presence → 🎯 Add Campaign

AI-generated

Summary

Create and launch a telephony campaign that either autodials provided phone numbers or sends them SMS messages, using specified campaign parameters.

Inputs

  • phone (required) — Internal user phone number used to obtain SIP numbers or configure routing.
  • from (required) — Internal number of the employee who creates and launches the campaign.
  • phones (required) — Comma-separated list of phone numbers to be added to the campaign for calling or SMS broadcasting.
  • type — Campaign type selection: 1 for phone calls (autodialing), 2 for SMS messages.
  • message — Text of the SMS message; required if campaign type is SMS. Limited to 160 characters (70 for Cyrillic).
  • ext — Employee extension number to receive campaign calls; defaults to the campaign initiator if not specified.
  • days — Comma-separated list of days of week when the campaign will run (0=Sunday, ..., 6=Saturday). Default is Monday to Friday.
  • time — Time window in HH:mm-HH:mm during which the campaign can make calls or send messages; defaults to 10:00-18:00.
  • try — Number of retry attempts for each number; default is 1 (single attempt). Range 1-10.
  • pdd — Post dial delay in seconds to fine-tune call timing; defaults to 0.
  • preview_timeout — Preview mode timeout in seconds, allowing operators to see client info before calls; defaults to 0 (disabled).

Output shape

a single record with campaign creation result data as returned by the LiraX API

The API response includes details about the newly created campaign. SMS message text is required if the campaign type is SMS. Phone number inputs must be numeric strings. The operation expects all required parameters to be provided; otherwise, the API may return an error.

Links

Discussion