Skip to main content
POST
voice.campaign.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
name
string
required

Your campaign name, 1 to 100 characters.

Required string length: 1 - 100
rows
object[]
required

1 to 100 recipients with unique ids and numbers.

Required array length: 1 - 100 elements
from
string
required

Your rented caller-id number.

Pattern: ^\+[1-9]\d{6,14}$
message
string

Text spoken to each recipient, up to 1000 characters; may contain personal text.

Required string length: 1 - 1000
flowKey
string

Your privately configured call-flow key.

Required string length: 1 - 100
maxDurationSeconds
integer
default:120

Maximum call duration, 60 to 600 seconds; requires a bounded message or configured flow.

Required range: 60 <= x <= 600
retries
integer
default:0

Retries per recipient, 0 to 3; increases the spending bound.

Required range: 0 <= x <= 3
sendAt
string<date-time>

Scheduled time in RFC3339 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
endAt
string<date-time>

Scheduled time in RFC3339 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

The result

state
enum<string>
required

Campaign state.

Available options:
created,
running,
paused,
completed,
archived
ref
string

Reference to what this call created. Pass it as ref to voice.campaign.get, voice.campaign.update or voice.campaign.resume.