CAcapacity
Voice Campaigns

Create a voice campaign and start outbound calling.

Creates and schedules a voice campaign. The contacts to dial can be supplied two ways:

  • Inline contacts: omit contact_list_id and provide a non-empty contacts array. A new contact list is created from name, the contacts are bulk-upserted into it, and the campaign is scheduled against it.
  • Existing list: supply contact_list_id referencing a list already in the caller's org. The campaign is scheduled against that list directly; any contacts array sent alongside is ignored. The list must contain at least one contact with both a primary phone number and a timezone.

Either contact_list_id or a non-empty contacts array is required.

post/v1/voice_campaigns

Request

  • Base URL
    https://api.capacity.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-capacity-id
    • or HTTP bearer

Request body

namestring required

Display name for the campaign and its underlying contact list.

from_numberstring required

E.164-formatted outbound phone number.

exchange_idinteger required

Exchange ID that handles the call once the destination answers.

contact_list_idinteger

ID of an existing contact list to use for this campaign. Mutually exclusive with contacts. The list must belong to the caller's org and contain at least one contact with both a primary phone number and a timezone.

start_time_utcstring date-time

UTC timestamp for the first dial attempt. Defaults to now if omitted.

repeat_interval_hoursinteger

Hours between campaign repeats.

retry_attemptsinteger

Maximum dial attempts per contact (0-3).

dial_to_agent_ratiointeger

Number of simultaneous dials per available agent.

repeat_end_utcstring date-time

UTC timestamp after which the campaign stops repeating.

Response

The created campaign.

idstring
userIdstring
orgIdstring
timeZonestring
namestring
outboundNumberstring
contactListIdstring
statusstring
exchangeIdstring
startTimeWindowstring date-time
endTimeWindowstring date-time
startTimestring date-time
repeatIntervalinteger
repeatEndstring date-time
retryAttemptsinteger
dialToAgentRatiointeger
createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.