Create a new DNI campaign

post

http://sandbox.callsource.com/campaigns/dni

Creates a DNI campaign for a site/domain and provisions a number pool.
Optional call settings on create: callShieldEnabled, callRecordingEnabled, callRecordingDisclaimerLanguage.
Optional autoscale on create: autoscaleEnabled, autoscaleMaxSize (required when enabled; one of 50, 100, 150, 200, 250, 300).
When autoscale is enabled, poolDidMatchingMethod is persisted for nightly pool expansion.
See CampaignCreationRequest. Static campaigns are not created on this route.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body for POST /campaigns/dni. Creates a DNI campaign and provisions a number pool for the site/domain. Optional call settings: callShieldEnabled, callRecordingEnabled, callRecordingDisclaimerLanguage (special, en, es, fr; special = DB call_disclaimer 0). Optional features: speechTranscriptionEnabled, redactionEnabled. Optional autoscale: autoscaleEnabled (default false), autoscaleMaxSize (required when enabled; one of 50, 100, 150, 200, 250, 300). When autoscale is enabled, poolDidMatchingMethod is persisted for nightly pool expansion.

siteId

integer

required

Associated site ID

campaignName

string

required

Campaign name

staticNumber

integer

required

1000000000 to 9999999999

DNI campaign static number as a 10-digit NPANXXXXXX integer (Asterisk extensions.conf _NXXNXXXXXX; N=2-9, X=0-9). No formatting or country code. On create/update, numeric strings are accepted and coerced to integer. Detail responses expose an integer via DniCampaignModel.

ringToNumber

string

required

Phone number to ring when calls come in

poolSize

integer

required

5 to 300

Number of phone numbers to reserve

poolNpaNxx

string

required

^\d{3,6}$

NPA-NXX pattern for phone numbers. Local numbers require you too provide 6 digits, toll-free numbers require NPA only.

poolDidMatchingMethod

string

enum

required

DID matching method for the initial pool and, when autoscaleEnabled is true, for nightly autoscale provisioning

Allowed:

callShieldEnabled

boolean

Enable call shield at creation

callRecordingEnabled

boolean

Enable call recording at creation

callRecordingDisclaimerLanguage

string

enum

Recording disclaimer language (special = no standard disclaimer; stored as call_disclaimer 0)

Allowed:

speechTranscriptionEnabled

boolean

Enable speech transcription at creation

redactionEnabled

boolean

Enable redaction at creation

autoscaleEnabled

boolean

Enable nightly pool autoscaling (default false)

autoscaleMaxSize

integer

enum

Maximum pool size when autoscale is enabled. Required when autoscaleEnabled is true.

Allowed:

emailActions

array of objects

Optional email actions to assign at creation (actionId from GET /sites/{id}/emails)

emailActions

webhookActions

array of objects

Optional webhook actions to assign at creation (actionId from GET /sites/{id}/webhooks)

webhookActions

Responses

201Campaign created successfully

400Bad request - Invalid input data or site missing domain

401Unauthorized - Invalid or missing token

403Forbidden - Insufficient permissions