Create a new static campaign

post

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

Provisions a single DID from inventory (or internal pool when configured) and creates a static campaign. Requires the site to have a domain.
Provide ringToNumber or callTreatmentId for default routing—not both; valid treatment ids come from GET /sites/{id}/calltreatments (use the site id as id).
Optional call settings on create: callShieldEnabled, callRecordingEnabled, callRecordingDisclaimerLanguage.
Optional features on create: redactionEnabled, speechTranscriptionEnabled, aiProcessingEnabled.
See StaticCampaignCreationRequest.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body for POST /campaigns/static. Provisions one DID from inventory using npaNxx and didMatchingMethod, then creates the campaign. The site must already have a domain configured. Provide either ringToNumber (new default endpoint) or callTreatmentId (existing call treatment / target id from GET /sites/{id}/calltreatments) as the campaign default routing target—not both. callTreatmentId must be one of the ids returned for that site. Optional call settings: callShieldEnabled, callRecordingEnabled, callRecordingDisclaimerLanguage (special, en, es, fr). Optional features: redactionEnabled, speechTranscriptionEnabled, aiProcessingEnabled.

siteId

integer

required

Site ID (must have a domain); may be less than zero

campaignName

string

required

Campaign display name

ringToNumber

string

10-digit ring-to / destination number. Required unless callTreatmentId is provided. Creates a new default target when set.

callTreatmentId

integer

≥ 1

Existing call treatment id. Required unless ringToNumber is provided. Ids are returned by GET /sites/{id}/calltreatments for that site.

npaNxx

string

required

^\d{3,6}$

NPA-NXX (3–6 digits). Toll-free: NPA only; local: full NPA-NXX.

didMatchingMethod

string

enum

required

Inventory matching method (same values as DNI pool 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:

redactionEnabled

boolean

Enable redaction

speechTranscriptionEnabled

boolean

Enable speech transcription

aiProcessingEnabled

boolean

Enable AI / leadscore processing when applicable

emailActions

array of objects

Optional email actions (actionId from GET /sites/{id}/emails; ring-to routing only)

emailActions

webhookActions

array of objects

Optional webhook actions (actionId from GET /sites/{id}/webhooks; ring-to routing only)

webhookActions

Responses

201Static campaign created successfully

400Bad request - Invalid input or site missing domain

401Unauthorized - Invalid or missing token

403Forbidden - Insufficient permissions

404Site not found